Page MenuHomeSoftware Heritage

git_bare: Fix and expand documentation
ClosedPublic

Authored by vlorentz on Tue, Nov 23, 3:48 PM.

Details

Summary

A few points were wrong/outdated.

This commit also adds a higher-level overview in the module docstring.

Depends on D6671.

Diff Detail

Repository
rDVAU Software Heritage Vault
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Build has FAILED

Patch application report for D6675 (id=24246)

Could not rebase; Attempt merge onto 1c83b82b49...

Updating 1c83b82..34c0c89
Fast-forward
 README.md                     |  9 ------
 docs/README.rst               | 49 ++++++++++++++++++++++++++++++++
 docs/index.rst                |  7 +----
 swh/vault/cookers/git_bare.py | 65 +++++++++++++++++++++++++++++++++++++++----
 4 files changed, 109 insertions(+), 21 deletions(-)
 delete mode 100644 README.md
 create mode 100644 docs/README.rst
Changes applied before test
commit 34c0c8993e11a5bafacaa4e0dc31e0cc8a5001ba
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Tue Nov 23 15:48:40 2021 +0100

    git_bare: Fix and expand documentation
    
    A few points were wrong/outdated.
    
    This commit also adds a higher-level overview in the module docstring.

commit 1087c2fd42ea73aafad72e2309d3f780ff42e76a
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Tue Nov 23 15:47:01 2021 +0100

    Add an introduction to the vault documentation

commit dd47302b5571572b8d3b4f048903c7f9f624ba24
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Tue Nov 23 15:22:31 2021 +0100

    git_bare: Fix counter of processed objects
    
    self._seen contains also all the objects on the todo-stacks,
    so it's incorrect to use it here.

Link to build: https://jenkins.softwareheritage.org/job/DVAU/job/tests-on-diff/191/
See console output for more information: https://jenkins.softwareheritage.org/job/DVAU/job/tests-on-diff/191/console

Harbormaster returned this revision to the author for changes because remote builds failed.Tue, Nov 23, 3:49 PM
Harbormaster failed remote builds in B25122: Diff 24246!

Build is green

Patch application report for D6675 (id=24255)

Could not rebase; Attempt merge onto 1c83b82b49...

Updating 1c83b82..4d2d0df
Fast-forward
 README.md                     |  9 ------
 README.rst                    |  1 +
 docs/README.rst               | 45 ++++++++++++++++++++++++++++
 docs/index.rst                |  7 +----
 setup.py                      |  4 +--
 swh/vault/cookers/git_bare.py | 68 +++++++++++++++++++++++++++++++++++++++----
 6 files changed, 111 insertions(+), 23 deletions(-)
 delete mode 100644 README.md
 create mode 120000 README.rst
 create mode 100644 docs/README.rst
Changes applied before test
commit 4d2d0dfdf8dc6917ec8925848ed260d494539da9
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Tue Nov 23 15:48:40 2021 +0100

    git_bare: Fix and expand documentation
    
    A few points were wrong/outdated.
    
    This commit also adds a higher-level overview in the module docstring.

commit 35e4fd7378b7da01c307236d4b5f734367d48b9f
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Tue Nov 23 15:47:01 2021 +0100

    Add an introduction to the vault documentation

commit 2683d573a84d67c5dc86df20ee82f2f4459c1e19
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Tue Nov 23 15:22:31 2021 +0100

    git_bare: Fix counter of processed objects
    
    self._seen contains also all the objects on the todo-stacks,
    so it's incorrect to use it here.

See https://jenkins.softwareheritage.org/job/DVAU/job/tests-on-diff/198/ for more details.

ardumont added a subscriber: ardumont.

lgtm

Although the imperative form should be used in the docstring.
I'll let you decide if you want to amend this diff or delay this for later.

swh/vault/cookers/git_bare.py
104

should be in the imperative form to match consistently the remaining part of our docstring.

This revision is now accepted and ready to land.Tue, Nov 23, 5:50 PM
swh/vault/cookers/git_bare.py
104

Other methods in this module already use present continuous, so I'll keep it like this for this diff. Maybe change it later

This revision was automatically updated to reflect the committed changes.