Manpage: note pre/post actions effect on an alias #4672
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mwichmann
changed the title
3 tasks
mwichmann
force-pushed
the
issue/alias-action
branch
from
3d0c7d9 to
b5a2151
Compare
mwichmann
force-pushed
the
issue/alias-action
branch
from
448bca2 to
d53a8ca
Compare
AddPostAction and AddPreAction apply to the action of the alias, which may not have been clear previously (see SCons#2281). Expanded the example for AddPreAction using a multi-step build. Signed-off-by: Mats Wichmann <[email protected]>
The initial version of PR #4872 proposed to document that pre- and post-actions on an alias have no effect if the alias has no action itself. Subsequently, PR #4874 was merged to change this behavior so that statement is backed out, but the other proposed doc improvements in this area are retained. Signed-off-by: Mats Wichmann <[email protected]>
mwichmann
force-pushed
the
issue/alias-action
branch
from
d53a8ca to
086a92b
Compare
bdbaddog
reviewed
Apr 3, 2025
| <para> | ||
| If a <parameter>target</parameter> is an Alias target, | ||
| <parameter>action</parameter> is associated with the | ||
| action of the alias, if specified. |
There was a problem hiding this comment.
Should alias be the Alias entity here?
bdbaddog
reviewed
Apr 3, 2025
| <parameter>action</parameter> | ||
| to be performed | ||
| before the specified | ||
| <parameter>target</parameter> | ||
| is built. | ||
| <parameter>target</parameter> |
There was a problem hiding this comment.
Any reason to only add this clarification here?
Seems like this is always true for all builders?
bdbaddog
reviewed
Apr 3, 2025
| @@ -440,7 +460,7 @@ file into an object file. | |||
| </arguments> | |||
| <summary> | |||
| <para> | |||
| Creates an <firstterm>alias</firstterm> target that | |||
| Create an <firstterm>Alias</firstterm> target that | |||
There was a problem hiding this comment.
Should this be Alias entity instead?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
AddPostActionandAddPreActionapply to the action of the alias, which may not have been clear previously (see #2281).Expanded the example for
AddPreActionusing a multi-step build.I don't consider that this completes the referenced issue, since it only provides information to those who happen to read those manpage snips - there is neither a warning on use nor a lessening of the impression that "it ought to work".
No code is affected.
Contributor Checklist:
CHANGES.txtandRELEASE.txt(and read theREADME.rst).