public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
From: "Jeremy Baxter" <jtbx@disroot.org>
To: "Alejandro Colomar" <alx@kernel.org>
Cc: <linux-man@vger.kernel.org>
Subject: Re: [PATCH] intro.1: Revise
Date: Sun, 17 Mar 2024 19:37:32 +1300	[thread overview]
Message-ID: <CZVTGGVFZWX7.20ENRHRXYB879@disroot.org> (raw)
In-Reply-To: <ZfTdm593ob_V1XhM@debian>

On Sat Mar 16, 2024 at 12:45 PM NZDT, Alejandro Colomar wrote:
> This patch is too big, and changes too much, for a single patch, I
> think.  Please split the patch into smaller patches that do one thing,
> and document those more precisely in the commit messages, instead of
> something generic, if possible.  See <./CONTRIBUTING.d/patches>:
>
>        -  Send logically separate patches.  For unrelated pages, or for
>           logically-separate issues in the same page, send separate
>           emails.

Hi Alex, at the time of writing I considered it appropriate according
to that guideline but yes I agree it is too generic.

> Please use semantic newlines (see man-pages(7)):
>
> $ MANWIDTH=72 man man-pages | sed -n '/Use semantic newlines/,/^$/p'
>    Use semantic newlines
>      In  the  source of a manual page, new sentences should be started
>      on new lines, long sentences should be split into lines at clause
>      breaks (commas, semicolons, colons, and so on), and long  clauses
>      should be split at phrase boundaries.  This convention, sometimes
>      known  as  "semantic newlines", makes it easier to see the effect
>      of patches, which often operate at the level of  individual  sen‐
>      tences, clauses, or phrases.

Sweet, will do. Thanks!

 ~Jeremy

      reply	other threads:[~2024-03-17  6:37 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-14 21:58 [PATCH] intro.1: Revise Jeremy Baxter
2024-03-15 23:45 ` Alejandro Colomar
2024-03-17  6:37   ` Jeremy Baxter [this message]

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=CZVTGGVFZWX7.20ENRHRXYB879@disroot.org \
    --to=jtbx@disroot.org \
    --cc=alx@kernel.org \
    --cc=linux-man@vger.kernel.org \
    /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