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

Improve Repository docs #4622

Merged
merged 3 commits into from
Oct 27, 2024
Merged

Improve Repository docs #4622

merged 3 commits into from
Oct 27, 2024

Conversation

mwichmann
Copy link
Collaborator

Give a few more details. Add example for another usecase to the User Guide.

At the same time - convert more "construction environment" and "construction variable" to entities in files already being edited.

Normalize on NEXT_RELEASE (since 4.8.1, some changed had used NEXT_RELEASE and some on NEXT_VERSION).

No code/test changes: Environment.py was a docstring change and EnvironmentTests.py comment changes.

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

Give a few more details. Add example for another usecase to the
User Guide.

At the same time - convert more "construction environment" and
"construction variable" to entities in files already being edited.

Normalize on NEXT_RELEASE (since 4.8.1, some changed had used
NEXT_RELEASE and some on NEXT_VERSION).
doc/user/repositories.xml Outdated Show resolved Hide resolved
doc/user/repositories.xml Outdated Show resolved Hide resolved
(or the <literal>--repository</literal> or
<literal>--srcdir</literal> synonyms)
command line option, or the build will abort.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I ran into this doing an experiment, and it seemed worth mentioning... we don't have to keep.

Copy link
Contributor

Choose a reason for hiding this comment

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

Interesting. I think it's quite uncommon to specify more than one repository, but definitely worth noting.
Not sure if I wouldn't consider that a bug.. but it's off on the edges so unless it breaks someones expectations.. I think it's ok for now.

@bdbaddog bdbaddog merged commit 879c91b into SCons:master Oct 27, 2024
@mwichmann mwichmann added this to the NextRelease milestone Oct 28, 2024
@mwichmann mwichmann deleted the doc/repository branch October 28, 2024 11:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Complete
Development

Successfully merging this pull request may close these issues.

2 participants