mbox series

[v2,0/3] Documentation of pack and repack

Message ID 20200312170931.2392490-1-damien.olivier.robert+git@gmail.com (mailing list archive)
Headers show
Series Documentation of pack and repack | expand

Message

Damien Robert March 12, 2020, 5:09 p.m. UTC 
The first patch is a small clean up I found when reading the source to try
to understand the behaviour of pack-objects when writing the documentation.

The second patch update the documentation.

These two are not changed from my previous round, except
- I changed the order
- I took into account the typos mentioned by Junio
- I removed the default options section which referred to the default
  options passed to `git pack-objects` by `git repack`

In particular in the second patch the only update to the options description
in git repack is still 'are passed to `git pack-objects`'.

I added a third patch that add some quick description of the options
-l, -f, -F and -q.

Damien Robert (3):
  pack-objects: change the name of add_objects_in_unpacked_packs
  doc: update the documentation of pack-objects and repack
  doc: add a short explanation for git-repack options

 Documentation/git-pack-objects.txt | 27 +++++++++----
 Documentation/git-repack.txt       | 62 +++++++++++++++++++-----------
 builtin/pack-objects.c             |  4 +-
 3 files changed, 61 insertions(+), 32 deletions(-)

Comments

Damien Robert March 25, 2020, 10:15 p.m. UTC | #1 
Just a friendly reminder about this series.

In particular, it would be nice to get a review on
>   doc: add a short explanation for git-repack options
since I am not a native english speaker.

Thanks!
Junio C Hamano March 27, 2020, 10:21 p.m. UTC | #2 
Damien Robert <damien.olivier.robert@gmail.com> writes:

> Just a friendly reminder about this series.
>
> In particular, it would be nice to get a review on
>>   doc: add a short explanation for git-repack options
> since I am not a native english speaker.

Anybody wants to help by taking this one to see the accuracy of
description in the updated doc (being a native English speaker is
not a hard requirement, and while it may help, being correct would
be more important than being grammatically perfect)?

The series starts here:

https://lore.kernel.org/git/20200312170931.2392490-1-damien.olivier.robert+git@gmail.com/

Thanks.