Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Manpage: note pre/post actions effect on an alias #4672

Merged
merged 6 commits into from
Apr 6, 2025

Conversation

mwichmann
Copy link
Collaborator

@mwichmann mwichmann commented Jan 3, 2025

AddPostAction and AddPreAction apply to the action of the alias, which may not have been clear previously (see #2281).

Expanded the example for AddPreAction using 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:

  • I have created a new test or updated the unit tests to cover the new/changed functionality.
  • I have updated CHANGES.txt and RELEASE.txt (and read the README.rst).
  • I have updated the appropriate documentation

@mwichmann mwichmann changed the title Manpage: note pre/post actions effect on an alias [skip appveyor] Manpage: note pre/post actions effect on an alias Jan 3, 2025
@mwichmann mwichmann force-pushed the issue/alias-action branch from 448bca2 to d53a8ca Compare March 3, 2025 15:20
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 mwichmann force-pushed the issue/alias-action branch from d53a8ca to 086a92b Compare March 8, 2025 14:04
@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be Alias entity instead?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a term we use anywhere else... but not necessarily averse to using a new term. We don't use "alias target" much either, unless I'm searching poorly.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe the word "Node" is what we want, since that's what is actually made?

@bdbaddog bdbaddog merged commit 76ff88d into SCons:master Apr 6, 2025
@mwichmann mwichmann added this to the NextRelease milestone Apr 7, 2025
@mwichmann mwichmann deleted the issue/alias-action branch April 7, 2025 13:31
@mwichmann mwichmann moved this to Done in Next Release Apr 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants