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.

Sign up for GitHub

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

Jump to bottom

Add a vcs module, with Git and Subversion support. #33

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

Add a vcs module, with Git and Subversion support. #33

wants to merge 19 commits into from

Conversation

tee3
Copy link
Contributor

@tee3 tee3 commented May 31, 2021

Proposed changes

See boostorg/build#135

Types of changes

See boostorg/build#135

Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Documentation content changes
  • Other (please describe):

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I searched the discussions
  • I searched the closed and open issues
  • I read the contribution guidelines
  • I added myself to the copyright attributions for significant changes
  • I checked that tests pass locally with my changes
  • I added tests that prove my fix is effective or that my feature works
  • I added necessary documentation (if appropriate)

Further comments

This stalled as it requires changes to the engine as described by @swatanabe in the original pull request. I am not sure if this is feasible or not.

tee3 added 19 commits May 31, 2021 12:51
@tee3
vcs: Added a vcs module, with Git and Subversion support.
c26ff71 
This provides a mechanism to interact with VCS-controlled projects.  It
currently supports Git and Subversion.  The main interesting feature
here is a rule to generate a version string.  There are other rules for
querying a directory for its properties that may also prove generally
useful.

There are also rules to 'fetch' from a repository into a directory and
'checkout' a symbolic reference from a directory.  These could be used
to forcibly get a specific revision of a package from a repository.  It
could also be used to create a proper source package management system
within Boost.Build.

There are two examples to show how this module might be used.

The documentation build has not been tested.  However, a
reStructuredText document that should be identical to the BoostBook file
is included in the doc directory for reference.

There are no tests, but there are two examples that do quite a bit of
work to test the module, but do not verify the results.

This has been tested on Linux, OS X, and Windows.  The 'type' rule fails
on Windows due to `path.exists' rule failing.  This needs to be
investigated.

This does not implement these functions in Python.  It should be
straightforward to do so.
@tee3
vcs: Fixes to vcs BoostBook.
32cbd6b 
The BoostBook for the vcs module was missing several sections and had
a few glaring mistakes.
@tee3
vcs: Use ".. code::" instead of "::" where possible.
84161fb 
This is clearer than using the literal section in these cases.
@tee3
vcs: Use ".. include::" to include code listings.
4b3906f 
While this is not as portable as including the code directly, this
matches the BoostBook documentation approach and makes ensuring that
the reStructredText documentation is identical to the DocBook
documentation.
@tee3
vcs: Moved design section after the reference sections.
5b310ce
@tee3
vcs: Move usage out of the reference section.
98d623d 
This change makes it easier to see the rules provided by the vcs
module.
@tee3
vcs: Minor cleanup to some code sections.
d10082f
@tee3
vcs: Improve readability of the documentation.
15773f9
@tee3
vcs: Backends do not currently support VMS.
8e57bac 
Some of the syntax in the SHELL commands is not compatible with VMS.
@tee3
vcs: Fixed a bug that caused checkout to fail.
843c639
@tee3
vcs: Added test for the basic features.
fe71d09 
This adds a test to test the functionality of all vcs functionality.

* type
* fetch
* checkout,
* ref
* generate-version-string.

This tests all backends.

* Git
* Subversion
@tee3
vcs: Fixed the GitHub URL in the vcs example.
4d278c5 
This change fixes the GitHub URL for the Boost.Build project.  The
previous URL was correct except that it ceased to work for Subversion
checkouts some time ago.
@tee3
vcs: Remove the vcs examples dependency on Boost.Build checkout.
d19c8a3 
This change removes the assumption that the working copy has been
checked out via a supported vcs.  Using the actual location of the
example/vcs directory in the example was not very useful and made
running the example from the test harness impossible.
@tee3
vcs: Do not print info in vcs example.
644fc93 
This change minimizes any confusion caused by unnecessary warnings.
@tee3
vcs: Skip fetch if working directory already exists in example.
7f2f089
@tee3
vcs: Simplified output in example generating a version string.
ac4bd68
@tee3
vcs: Run example generating a versions string during test.
96f83c8
@tee3
vcs: Run complete vcs example during test.
15f29af
@tee3
vcs: Ensure vcs-git protects user from git stderr.
bc6a976 
This change ensures that stderr is not printed when an exact match, as
expected, is not found.  The stderr from git was confusing to users.
@tee3 tee3 mentioned this pull request May 31, 2021
Closed
4 tasks
@tee3
Copy link
Contributor Author

tee3 commented May 31, 2021

@grafikrobot

  1. Do you think this would be a useful addition? I saw that there is package manager support in B2 now, but I have never figured out how to use it, nor Conan. Does this package manager support make this module obsolete?
  2. If this is still something that might be useful, have the changes to LOCATE described in the original pull request been done? Can they be?
  3. Do you have a better design for this that I could try to implement?
  4. I am by no means a B2 expert, but I have managed to build some useful modules for my purposes (interfacing to the Xilinx tools, toolsets for TI compilers, etc.). I'm sure they could all be better, but I have learned a lot in the process. I would be willing to do the work on this module to make it work within the B2 targets, etc. if there was a chance it would be useful.
  5. There is a very small subset of this vcs module that could be useful. It can generate a version string looking at the underlying vcs repository. I use this to generate versions in my professional work and it is really useful and seems to work properly in all cases. I would be willing to break that out to start if you feel it is useful.
  6. If you have a better idea on how to accomplish this or feel it is not useful, I am fine with closing the pull request

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
BFG Tasks
Status: No status
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@tee3 @grafikrobot