[PATCH v3 0/4] Add support for %(contents:size) in ref-filter

This is version 3 of a small patch series to teach ref-filter about %(contents:size).

This patch series is based on current master.

Previous versions and related discussions are here:

V1: https://lore.kernel.org/git/20200701132308.16691-1-chriscool@tuxfamily.org/
V2: https://lore.kernel.org/git/20200702140845.24945-1-chriscool@tuxfamily.org/

Thanks to Junio and Peff for their reviews of this series!

The changes compared to V2 are the following:

  - Added patch 2/4 that clarifies the meaning of "complete message"
    in the doc.

  - Added patch 3/4 that adds tests for refs pointing to a tree or a
    blob.

  - Improved commit message in patch 4/4 as suggested by Junio.

  - Added %(contents:size) tests in patch 4/4 for refs pointing to a
    tree or a blob.

The range diff is:

1:  c6e80b8bc1 = 1:  b04b390f32 Documentation: clarify %(contents:XXXX) doc
-:  ---------- > 2:  b62cab2630 Documentation: clarify 'complete message'
-:  ---------- > 3:  b9584472a1 t6300: test refs pointing to tree and blob
2:  9853b37091 ! 4:  23f941132e ref-filter: add support for %(contents:size)
    @@ Commit message
     
         Also the result of the following:
     
    -    `git for-each-ref --format='%(contents)' | wc -c`
    +    `git for-each-ref --format='%(contents)' refs/heads/my-branch | wc -c`
     
         is off by one as `git for-each-ref` appends a newline character
    -    after the contents, which can be seen by comparing its ouput
    +    after the contents, which can be seen by comparing its output
         with the output from `git cat-file`.
     
    +    As with %(contents), %(contents:size) is silently ignored, if a
    +    ref points to something other than a commit or a tag:
    +
    +    ```
    +    $ git update-ref refs/mytrees/first HEAD^{tree}
    +    $ git for-each-ref --format='%(contents)' refs/mytrees/first
    +
    +    $ git for-each-ref --format='%(contents:size)' refs/mytrees/first
    +
    +    ```
    +
         Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
     
      ## Documentation/git-for-each-ref.txt ##
    -@@ Documentation/git-for-each-ref.txt: and `date` to extract the named component.
    - The complete message of a commit or tag object is `contents`. This
    - field can also be used in the following ways:
    +@@ Documentation/git-for-each-ref.txt: The complete message (subject, body, trailers and signature) of a
    + commit or tag object is `contents`. This field can also be used in the
    + following ways:
      
     +contents:size::
     +  The size in bytes of the complete message.
    @@ t/t6300-for-each-ref.sh: test_atom refs/tags/signed-long contents "subject line
      $sig"
     +test_tag_contents_size_pgp refs/tags/signed-long
      
    + test_expect_success 'set up refs pointing to tree and blob' '
    +   git update-ref refs/mytrees/first refs/heads/master^{tree} &&
    +@@ t/t6300-for-each-ref.sh: test_atom refs/mytrees/first body ""
    + test_atom refs/mytrees/first contents:body ""
    + test_atom refs/mytrees/first contents:signature ""
    + test_atom refs/mytrees/first contents ""
    ++test_atom refs/mytrees/first contents:size ""
    + 
    + test_atom refs/myblobs/first subject ""
    + test_atom refs/myblobs/first contents:subject ""
    +@@ t/t6300-for-each-ref.sh: test_atom refs/myblobs/first body ""
    + test_atom refs/myblobs/first contents:body ""
    + test_atom refs/myblobs/first contents:signature ""
    + test_atom refs/myblobs/first contents ""
    ++test_atom refs/myblobs/first contents:size ""
    + 
      test_expect_success 'set up multiple-sort tags' '
        for when in 100000 200000

Christian Couder (4):
  Documentation: clarify %(contents:XXXX) doc
  Documentation: clarify 'complete message'
  t6300: test refs pointing to tree and blob
  ref-filter: add support for %(contents:size)

 Documentation/git-for-each-ref.txt | 28 +++++++++++++++-----
 ref-filter.c                       |  7 ++++-
 t/t6300-for-each-ref.sh            | 41 ++++++++++++++++++++++++++++++
 3 files changed, 69 insertions(+), 7 deletions(-)