diff mbox series

Documentation/glossary: describe "trailer"

Message ID ba35ba3ec212860a3151cfad582a384a50c55e6a.1731871683.git.code@khaugsbakk.name (mailing list archive)
State Accepted
Commit 68e3c69efae688165a70f1e81b238fbbbff9a4b0
Headers show
Series Documentation/glossary: describe "trailer" | expand

Commit Message

Kristoffer Haugsbakk Nov. 17, 2024, 7:33 p.m. UTC
From: Kristoffer Haugsbakk <code@khaugsbakk.name>

Reported-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---

Notes (series):
    On Wed, Nov 13, 2024, at 23:31, Junio C Hamano wrote:
    > Christian Couder <christian.couder@gmail.com> writes:
    > > [...]
    > We do not even have an entry in the glossary for "trailer", and that
    > probably is the first thing we need to fix.
    
    ---
    
    • Tags: What the Linux Kernel uses
    • Footers: Lots of people around the Internet apparently. Like on
      Stackoverflow. Or Chromium: https://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/git-footers.html

 Documentation/glossary-content.txt | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Junio C Hamano Nov. 18, 2024, 12:40 a.m. UTC | #1
kristofferhaugsbakk@fastmail.com writes:

> diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
> index 42afe048691..575c18f776e 100644
> --- a/Documentation/glossary-content.txt
> +++ b/Documentation/glossary-content.txt
> @@ -696,6 +696,11 @@ the `refs/tags/` hierarchy is used to represent local tags..
>  	that each contain very well defined concepts or small incremental yet
>  	related changes.
>  
> +[[def_trailer]]trailer::
> +	Key-value metadata.  Trailers are optionally found at the end of
> +	a commit message.  Might be called "footers" or "tags" in other
> +	communities.  See linkgit:git-interpret-trailers[1].

Sounds sensible.
Christian Couder Nov. 18, 2024, 7:32 a.m. UTC | #2
On Sun, Nov 17, 2024 at 8:34 PM <kristofferhaugsbakk@fastmail.com> wrote:
>
>     • Tags: What the Linux Kernel uses
>     • Footers: Lots of people around the Internet apparently. Like on
>       Stackoverflow. Or Chromium: https://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/git-footers.html
>
>  Documentation/glossary-content.txt | 5 +++++
>  1 file changed, 5 insertions(+)
>
> diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
> index 42afe048691..575c18f776e 100644
> --- a/Documentation/glossary-content.txt
> +++ b/Documentation/glossary-content.txt
> @@ -696,6 +696,11 @@ the `refs/tags/` hierarchy is used to represent local tags..
>         that each contain very well defined concepts or small incremental yet
>         related changes.
>
> +[[def_trailer]]trailer::
> +       Key-value metadata.  Trailers are optionally found at the end of
> +       a commit message.  Might be called "footers" or "tags" in other
> +       communities.  See linkgit:git-interpret-trailers[1].
> +

Ack, thanks!
diff mbox series

Patch

diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index 42afe048691..575c18f776e 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -696,6 +696,11 @@  the `refs/tags/` hierarchy is used to represent local tags..
 	that each contain very well defined concepts or small incremental yet
 	related changes.
 
+[[def_trailer]]trailer::
+	Key-value metadata.  Trailers are optionally found at the end of
+	a commit message.  Might be called "footers" or "tags" in other
+	communities.  See linkgit:git-interpret-trailers[1].
+
 [[def_tree]]tree::
 	Either a <<def_working_tree,working tree>>, or a <<def_tree_object,tree
 	object>> together with the dependent <<def_blob_object,blob>> and tree objects