Message ID | 20211216105246.3548133-1-daniel@0x0f.com (mailing list archive) |
---|---|
Headers | show |
Series | ARM: mstar: Initial Miyoo Mini support | expand |
Hi Romain, On Fri, 17 Dec 2021 at 00:53, Romain Perier <romain.perier@gmail.com> wrote: > > Hi Daniel, > > Le jeu. 16 déc. 2021 à 11:52, Daniel Palmer <daniel@0x0f.com> a écrit : >> >> - I've left the link tags as-is as using them for linking >> to background info seems acceptable. > > > https://www.kernel.org/doc/html/latest/maintainer/configure-git.html#creating-commit-links-to-lore-kernel-org The explanation of Link seem to have been updated recently in 1f57bd42b77cdc4b8e05ba9f4417872a6691b66d (https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes a few paragraphs down). My reading of the paragraph since that commit is: Explain what the commit does in the commit message. If there is a bug that prompted the change then link it. If there is some background for the commit then link it. If it needs to be changed around I'll do that but I personally think it looks nicer. It seems like the right way to provide links to datasheets etc without putting a bunch of long messy urls into the commit message. Cheers, Daniel
Hi Daniel, Le jeu. 16 déc. 2021 à 17:15, Daniel Palmer <daniel@0x0f.com> a écrit : > > Hi Romain, > > On Fri, 17 Dec 2021 at 00:53, Romain Perier <romain.perier@gmail.com> wrote: > > > > Hi Daniel, > > > > Le jeu. 16 déc. 2021 à 11:52, Daniel Palmer <daniel@0x0f.com> a écrit : > >> > >> - I've left the link tags as-is as using them for linking > >> to background info seems acceptable. > > > > > > https://www.kernel.org/doc/html/latest/maintainer/configure-git.html#creating-commit-links-to-lore-kernel-org > > The explanation of Link seem to have been updated recently in > 1f57bd42b77cdc4b8e05ba9f4417872a6691b66d > (https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes > a few paragraphs down). > > My reading of the paragraph since that commit is: Explain what the > commit does in the commit message. If there is a bug that prompted the > change then link it. If there is some background for the commit then > link it. > > If it needs to be changed around I'll do that but I personally think > it looks nicer. It seems like the right way to provide links to > datasheets etc without putting a bunch of long messy urls into the > commit message. Well, I agree it is confusing. So I have discussed privately about this with Arnd (on IRC): <rperier> What is the real usage of the "Link:" tag ? it is mainly used as background informations for referencing archives or patches on lore.k.o , but it can also be used for referencing something else or not ? (like information for a board) [...] <arnd> right, it's pretty much never wrong to add a Link: tag for the patch submission that was picked up, but you can also add it for any other reference, e.g.issue trackers or datasheets that may be relevant ---- Which replies to the question, so it is okay for me ;) Romain
Hi Romain, On Fri, 17 Dec 2021 at 02:34, Romain Perier <romain.perier@gmail.com> wrote: > Well, I agree it is confusing. So I have discussed privately about > this with Arnd (on IRC): Yeah. I think in the same document for submitting patches it also says no html (obvious), no links.. ;) > <rperier> What is the real usage of the "Link:" tag ? it is mainly > used as background informations for referencing archives or patches on > lore.k.o , but it can also be used for referencing something else or > not ? > (like information for a board) > [...] > <arnd> right, it's pretty much never wrong to add a Link: tag for the > patch submission that was picked up, but you can also add it for any > other reference, e.g.issue trackers or datasheets that may be relevant > > ---- > > Which replies to the question, so it is okay for me ;) Thank you for going the extra mile and confirming with Arnd. I want to start adding a link to our wiki for every board we add as the documentation is all over the place for these things, suddenly disappears etc. There's a 3 commit series coming for another SSD202D board in a few days that will look just like this one. Maybe now you have the sbc2d70 board you could add the DTS for that too and we can pull all of these new boards in one DT pull request? Cheers, Daniel