On Tue, Sep 11, 2018 at 1:19 PM, Derrick Stolee [off-list ref] wrote:

On 9/11/2018 1:22 AM, Christian Couder wrote:

quoted

It would be nice if the "Future Work" section of
Documentation/technical/commit-graph.txt had something about
integration with 'git gc'.

I'm a bit confused about this statement, because at the point in time of
this patch we had a spot in the "Future Work" section about automatically
updating the graph _somewhere_. The "future integration with 'git gc'" I
refer to in this patch is implemented in PATCH 21/22. In PATCH 22/22 we
removed this section from the technical doc:

Yeah, sorry I had not seen PATCH 21/22. I was interested in an update
about the commit graph feature and especially to know if the way to
use it had been simplified in v2.19.0, so I took a look at the
Documentation/technical/commit-graph.txt and
Documentation/git-commit-graph.txt, but I didn't find anything there
except the `--reachable` option. So I thought that integrating with gc
was still something that needed to be worked on.

Now that this feature is shipped in Git 2.19.0, this no longer belongs in
"Future Work".

This is great!

It would be nice though to have something in
Documentation/technical/commit-graph.txt and perhaps also
Documentation/git-commit-graph.txt about it, as it is easy to overlook
the gc.writeCommitGraph documentation in Documentation/config.txt.

quoted

The "EXAMPLES" section still contains:

* Write a graph file containing all reachable commits.
+
------------------------------------------------
$ git show-ref -s | git commit-graph write --stdin-commits
------------------------------------------------

I wonder if this should have been changed to use `--reachable`.

Thanks!

This is a good idea. I can work on that.

Thanks,
Christian.