Manpage: modify the Builder Methods section #4671
Closed
+280
−384
Conversation
This file contains hidden or 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
bdbaddog
reviewed
Feb 16, 2025
| When specifying path strings, | ||
| &Python; follows the POSIX pathname convention: | ||
| if a string begins with the operating system pathname separator | ||
| (on Windows both the slash and backslash separator are accepted, |
There was a problem hiding this comment.
Is this info included elsewhere in your modified version? (slash and backslash both accepted on windows for dirsep?)
There was a problem hiding this comment.
Been a while... I think it just felt redundant. Didn't think we needed to be defining what an absolute path is.
|
Grumble tried to update this, now CHANGES and RELEASE have reset for the 4.9 release, and github tells me "fatal: The upstream branch of your current branch does not match the name of your current branch." Dunno what that's about... |
|
Hmmm, I remember trying to attach the condensed text versions of the manpage output, but they don't seem to be in this issue. Trying again here: |
mwichmann
force-pushed
the
doc/builder-methods
branch
from
efe6879 to
7eb0d11
Compare
|
I've marked this as "in progress" on the task board while I figure out what to do. |
mwichmann
added a commit
to mwichmann/scons
that referenced
this pull request
Sep 4, 2025
These are changes harvested from abandoned PR SCons#4671 so they're not lost. These changes were not the large surgery to doc/man/scons.xml about builders. The changes consist of a few formatting changes, moving one chunk of text i nthe SharedObject doc down ito its own paragraph and consistently using single_source as a boolean Signed-off-by: Mats Wichmann <mats@linux.com>
mwichmann
force-pushed
the
doc/builder-methods
branch
from
7eb0d11 to
0a5a193
Compare
mwichmann
added a commit
to mwichmann/scons
that referenced
this pull request
Sep 5, 2025
Small changes harvested from abandoned PR SCons#4671 so they're not lost. These changes omit the large surgery to the Builder Objects section in doc/man/scons.xml from the PR. The changes consist of a few doc formatting changes, entity usage, moving one chunk of text in the SharedObject entry down ito its own paragraph, noting when a builder is single source, and, in the code, consistently using the single_source builder argument as a boolean. Signed-off-by: Mats Wichmann <mats@linux.com>
mwichmann
force-pushed
the
doc/builder-methods
branch
from
0a5a193 to
7273ea6
Compare
In clarifying the detail on when a builder's target can be deduced, it seemed like the concept of a single-source builder ought to be introduced in this context. So now those builders we know are single-source have that notation in their entry in this section. Also mentions that pseudo-Builders may have a diffeent calling sequence. A chunk of text about dependencies previously appeared after the listing of builder methods, where it would be hard to spot. Moved up into the text before the listing, and integrate in a bit more smoothly. A couple of very minor typing things adjusted along the way - mainly using single_source consistently as a bool. Signed-off-by: Mats Wichmann <mats@linux.com>
mwichmann
force-pushed
the
doc/builder-methods
branch
from
7273ea6 to
a555952
Compare
mwichmann
added a commit
to mwichmann/scons
that referenced
this pull request
Sep 9, 2025
This is part of unmerged PR SCons#4671. This change moves two short sections around: * The note on builders and dependencies is moved to before the listing of methods be consistent with the other three sections of this type: all "descriptive text" followed by included generated listing, with no text following that. * The note on debugging user-written builders moves from the Builder Methods section to the Builder Objects section, where it seems more natural: the need to debug a builder seems a lot less likely with the pre-built Builders. Some rewording, as well. Signed-off-by: Mats Wichmann <mats@linux.com>
3 tasks
|
Withdrawn. Will be resubmitted in smaller chunks as time permits. |
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.
In clarifying the detail on when a builder's target can be deduced, it seemed like the concept of a single-source builder should be introduced in this context. So now those builders we know are single-source have that notation in their entry in this section. Also mentions that pseudo-Builders may have a different calling sequence.
A chunk of text about dependencies previously appeared after the listing of builder methods, where it would be hard to spot. Moved up into the text before the listing, and integrate in a bit more smoothly.
A couple of very minor typing things adjusted along the way - mainly using
single_sourceconsistently as abool.There are no functional changes, so no test impacts.
Contributor Checklist:
CHANGES.txtandRELEASE.txt(and read theREADME.rst).