hu-macsy / simexpal

Simplifying Experimental Algorithmics
https://simexpal.readthedocs.io
MIT License
17 stars 18 forks source link

Develop Revisions: Update Documenation #141

Closed c-bebop closed 10 months ago

c-bebop commented 1 year ago

When using the develop revisions option setting develop: true, the git commit/branch entries under the key build_version for each repository will be ignored. Instead, the latest state of the repository of its default branch will be checked out after cloning.

This behavior is not clearly documented. The following text under https://simexpal.readthedocs.io/en/latest/revisions.html#develop-revisions shall be changed:

From: _Values specified in the build_version dict will be ignored for develop revisions and SimExPal will clone the latest project files._

To: _Values specified for the buildversion key will be ignored for develop revisions. Instead, the latest commit of the default branch will be checked out after cloning the repository.

Further we could add: Use git commands within the cloned repositories to switch branches or checkout to another commit.