linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Conor Dooley <conor@kernel.org>
To: Palmer Dabbelt <palmer@dabbelt.com>
Cc: bagasdotme@gmail.com, Conor Dooley <conor.dooley@microchip.com>,
	linux-riscv@lists.infradead.org, linux-doc@vger.kernel.org,
	corbet@lwn.net, lkp@intel.com
Subject: Re: [PATCH] Documentation: riscv: fix insufficient list item indent
Date: Thu, 9 Feb 2023 19:23:31 +0000	[thread overview]
Message-ID: <Y+VIM8YGSPdSnC/9@spud> (raw)
In-Reply-To: <mhng-4defd1c9-ee2a-4f95-89f9-7c47ee6b97e9@palmer-ri-x1c9a>

[-- Attachment #1: Type: text/plain, Size: 2284 bytes --]

On Thu, Feb 09, 2023 at 10:48:58AM -0800, Palmer Dabbelt wrote:
> On Sun, 29 Jan 2023 19:05:53 PST (-0800), bagasdotme@gmail.com wrote:
> > On Sun, Jan 29, 2023 at 11:57:01PM +0000, Conor Dooley wrote:
> > > From: Conor Dooley <conor.dooley@microchip.com>
> > > 
> > > When adding the ISA string ordering rules, I didn't sufficiently indent
> > > one of the list items.
> > > 
> > > Reported-by: kernel test robot <lkp@intel.com>
> > > Fixes: f07b2b3f9d47 ("Documentation: riscv: add a section about ISA string ordering in /proc/cpuinfo")
> > > Signed-off-by: Conor Dooley <conor.dooley@microchip.com>
> > 
> > Seems like you forget to add link to the report:
> > 
> > Link: https://lore.kernel.org/linux-doc/202301300743.bp7Dpazv-lkp@intel.com/
> 
> Is that the normal way to do it?  I've only been adding the Reported-by like
> the bot suggests, but I guess it's kind of nice information to have the bug
> report as well.  From looking at git history it's kind of a mix.

IMO it totally depends on whether there is something useful in the
thread on lore. I see no point adding the links if they're just a
regurgitation of something conveyed in a commit message.

But then again, I don't bother adding a lore link to patchsets I apply
either. I'm in the Torvald's camp of only using those tags to link to
things containing "actual new information". There was a discussion of
that a while back, see [1] & [2] if you care, although it was largely
born out of frustration at links added by maintainers to original
submissions, not subjectively redundant bot emails.

Following that logic, I didn't bother adding one here, just as I
wouldn't for a compilation error if I included it in the commit log.

We've probably spent more time typing emails about it than the issue
warrants, but that's par for the course I suppose!

1 - https://lore.kernel.org/all/CAHk-=wj9zKJGA_6SJOMPiQEoYke6cKX-FV3X_5zNXOcFJX1kOQ@mail.gmail.com/
2 - https://lore.kernel.org/all/CAHk-=wgzRUT1fBpuz3xcN+YdsX0SxqOzHWRtj0ReHpUBb5TKbA@mail.gmail.com/
> Maybe the bot should suggest this in the bug report, right next to the other
> tag?

Iff the bot knows its own message-id before sending, I think that could
be nice to have. Does Intel's mail system may support that?

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

  reply	other threads:[~2023-02-09 19:23 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-29 23:57 [PATCH] Documentation: riscv: fix insufficient list item indent Conor Dooley
2023-01-30  3:05 ` Bagas Sanjaya
2023-01-31 19:18   ` Conor Dooley
2023-02-09 18:48   ` Palmer Dabbelt
2023-02-09 19:23     ` Conor Dooley [this message]
2023-02-07 14:58 ` Conor Dooley
2023-02-09 18:48   ` Palmer Dabbelt
2023-02-09 18:44 ` Palmer Dabbelt
2023-02-15 15:00 ` patchwork-bot+linux-riscv

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=Y+VIM8YGSPdSnC/9@spud \
    --to=conor@kernel.org \
    --cc=bagasdotme@gmail.com \
    --cc=conor.dooley@microchip.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-riscv@lists.infradead.org \
    --cc=lkp@intel.com \
    --cc=palmer@dabbelt.com \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).