All of lore.kernel.org
 help / color / mirror / Atom feed
From: kristofferhaugsbakk@fastmail.com
To: git@vger.kernel.org
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>,
	phillip.wood@dunelm.org.uk, gitster@pobox.com,
	bence@ferdinandy.com, karthik.188@gmail.com
Subject: [PATCH 0/6] doc: update-ref: amend old material and discuss symrefs
Date: Tue, 15 Oct 2024 21:03:09 +0200	[thread overview]
Message-ID: <cover.1729017728.git.code@khaugsbakk.name> (raw)
In-Reply-To: <CAOLa=ZQJy1ZkQqBoWwJJvL0f+NCP=3SAfyeSNuztgApzNH1mGg@mail.gmail.com>

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

(See the previous email for the context)

This series removes or moves some old material in the update-ref doc and
improves the discussion of symrefs, opting for a high-level description
with some redundancy (see patch 5/6) in order to avoid a reported
mistake/confusion.

The end goal (after all patches are applied):

• First paragraph (in Description) describes the first form
• Second paragraph the second form
• Third paragraph mentions symrefs and explains why `--stdin` supports
  them
• A new section whither the symlink (FS) vs. symrefs (`ref: ` files… or
  strings nowadays with the different formats that refs can have?)
  discussion is moved
• Link update-ref to symbolic-ref and vice versa

Kristoffer Haugsbakk (6):
  doc: update-ref: drop “flag”
  doc: update-ref: remove safety paragraphs
  doc: update-ref: demote symlink to last section
  doc: update-ref: remove confusing paragraph
  doc: update-ref: discuss symbolic links
  doc: mutually link update-ref and symbolic-ref

 Documentation/git-symbolic-ref.txt |  4 +++
 Documentation/git-update-ref.txt   | 48 +++++++++++++-----------------
 2 files changed, 25 insertions(+), 27 deletions(-)


base-commit: ef8ce8f3d4344fd3af049c17eeba5cd20d98b69f
-- 
2.46.1.641.g54e7913fcb6


  parent reply	other threads:[~2024-10-15 19:05 UTC|newest]

Thread overview: 54+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-11 20:51 ref: with git update-ref? Bence Ferdinandy
2024-10-11 20:56 ` Kristoffer Haugsbakk
2024-10-11 21:04   ` Bence Ferdinandy
2024-10-11 21:28     ` Junio C Hamano
2024-10-12 19:41       ` Bence Ferdinandy
2024-10-13  9:34       ` Phillip Wood
2024-10-13 10:07         ` Kristoffer Haugsbakk
2024-10-13 12:09           ` karthik nayak
2024-10-13 15:39             ` Kristoffer Haugsbakk
2024-10-13 20:40               ` Bence Ferdinandy
2024-10-14 15:06             ` Kristoffer Haugsbakk
2024-10-15 19:03             ` kristofferhaugsbakk [this message]
2024-10-15 19:03               ` [PATCH 1/6] doc: update-ref: drop “flag” kristofferhaugsbakk
2024-10-16 20:45                 ` Taylor Blau
2024-10-16 22:08                   ` Eric Sunshine
2024-10-16 22:09                     ` Taylor Blau
2024-10-17 15:30                       ` Kristoffer Haugsbakk
2024-10-17 16:31                         ` Eric Sunshine
2024-10-17 18:50                           ` Taylor Blau
2024-10-15 19:03               ` [PATCH 2/6] doc: update-ref: remove safety paragraphs kristofferhaugsbakk
2024-10-16 20:47                 ` Taylor Blau
2024-10-15 19:03               ` [PATCH 3/6] doc: update-ref: demote symlink to last section kristofferhaugsbakk
2024-10-15 19:03               ` [PATCH 4/6] doc: update-ref: remove confusing paragraph kristofferhaugsbakk
2024-10-16 20:51                 ` Taylor Blau
2024-10-16 20:55                   ` Kristoffer Haugsbakk
2024-10-16 20:57                     ` Taylor Blau
2024-10-15 19:03               ` [PATCH 5/6] doc: update-ref: discuss symbolic links kristofferhaugsbakk
2024-10-15 19:08                 ` Kristoffer Haugsbakk
2024-10-16 20:52                   ` Taylor Blau
2024-10-15 19:03               ` [PATCH 6/6] doc: mutually link update-ref and symbolic-ref kristofferhaugsbakk
2024-10-16  8:51               ` [PATCH 0/6] doc: update-ref: amend old material and discuss symrefs Bence Ferdinandy
2024-10-16 20:54               ` Taylor Blau
2024-10-16 21:00                 ` Kristoffer Haugsbakk
2024-10-19 19:59               ` [PATCH v2 " kristofferhaugsbakk
2024-10-19 19:59                 ` [PATCH v2 1/6] Documentation/git-update-ref.txt: drop “flag” kristofferhaugsbakk
2024-10-20 11:09                   ` karthik nayak
2024-10-19 19:59                 ` [PATCH v2 2/6] Documentation/git-update-ref.txt: remove safety paragraphs kristofferhaugsbakk
2024-10-20 11:13                   ` karthik nayak
2024-10-20 12:30                     ` Kristoffer Haugsbakk
2024-10-20 16:24                     ` Kristoffer Haugsbakk
2024-10-19 19:59                 ` [PATCH v2 3/6] Documentation/git-update-ref.txt: demote symlink to last section kristofferhaugsbakk
2024-10-19 19:59                 ` [PATCH v2 4/6] Documentation/git-update-ref.txt: remove confusing paragraph kristofferhaugsbakk
2024-10-19 19:59                 ` [PATCH v2 5/6] Documentation/git-update-ref.txt: discuss symbolic refs kristofferhaugsbakk
2024-10-19 19:59                 ` [PATCH v2 6/6] Documentation: mutually link update-ref and symbolic-ref kristofferhaugsbakk
2024-10-20 11:16                 ` [PATCH v2 0/6] doc: update-ref: amend old material and discuss symrefs karthik nayak
2024-10-21 20:47                 ` [PATCH v3 " kristofferhaugsbakk
2024-10-21 20:47                   ` [PATCH v3 1/6] Documentation/git-update-ref.txt: drop “flag” kristofferhaugsbakk
2024-10-21 20:47                   ` [PATCH v3 2/6] Documentation/git-update-ref.txt: remove safety paragraphs kristofferhaugsbakk
2024-10-21 20:47                   ` [PATCH v3 3/6] Documentation/git-update-ref.txt: demote symlink to last section kristofferhaugsbakk
2024-10-21 20:47                   ` [PATCH v3 4/6] Documentation/git-update-ref.txt: remove confusing paragraph kristofferhaugsbakk
2024-10-21 20:47                   ` [PATCH v3 5/6] Documentation/git-update-ref.txt: discuss symbolic refs kristofferhaugsbakk
2024-10-21 20:47                   ` [PATCH v3 6/6] Documentation: mutually link update-ref and symbolic-ref kristofferhaugsbakk
2024-10-21 20:50                   ` [PATCH v3 0/6] doc: update-ref: amend old material and discuss symrefs Taylor Blau
2024-10-12  6:25 ` ref: with git update-ref? Andreas Schwab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cover.1729017728.git.code@khaugsbakk.name \
    --to=kristofferhaugsbakk@fastmail.com \
    --cc=bence@ferdinandy.com \
    --cc=code@khaugsbakk.name \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=karthik.188@gmail.com \
    --cc=phillip.wood@dunelm.org.uk \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.