Skip to contentSkip to conversation

Link: documentation seems to be misplaced

DISCUSSION Russell King - ARM Linux admin 2 participants 2 messages Dec 12, 2019 – Dec 16, 2019 Documentation

lore
Share & tools
lore
#0 lore raw

Hi,

It seems that the documentation for the Link: attribute in commit messages is misplaced in the Documentation/ subtree.

There are two workflows:

1) maintainer committing external patches that have come from a mailing list.

2) maintainer committing local patches that have been discussed on a mailing list.

While the current documentation seems to target initial setup for new people becoming maintainers, but it is way less obvious for existing maintainers or for case 2 - I came across this because I wanted to add a Link: tag for a discussion on a patch I'd posted, and could find nothing to describe it. My grep for it failed:

grep Link: Documentation/*/*ubmitting*

Surely, the format of the Link: tag should be documented in the submitting-patches document with all the other attributations that we define in a commit message, with a reference to that from Documentation/maintainer/configure-git.rst ?

Thanks to Jiri Kosina for pointing out that it is in configure-git.rst.

Signature · 3 lines
RMK's Patch system: https://www.armlinux.org.uk/developer/patches/
FTTC broadband for 0.8mile line in suburbia: sync at 12.1Mbps down 622kbps up
According to speedtest.net: 11.9Mbps down 500kbps up
#1 lore raw

Hi Russell,

Quoted 4 lines · Russell King - ARM Linux admin

Surely, the format of the Link: tag should be documented in the submitting-patches document with all the other attributations that we define in a commit message, with a reference to that from Documentation/maintainer/configure-git.rst ?

I agree, so I sent a rough patch as a starting point so we get something going here.

Yours,
Linus Walleij