public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
From: Alejandro Colomar <alx@kernel.org>
To: Rajesh Pandian <r.pandian@gmail.com>
Cc: linux-man@vger.kernel.org
Subject: Re: [PATCH] bugzilla_218018
Date: Mon, 1 Jan 2024 12:56:10 +0100	[thread overview]
Message-ID: <ZZKoWlGumW-0cGJN@debian> (raw)
In-Reply-To: <20231228155601.16558-1-r.pandian@gmail.com>

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

Hi Rajesh,

On Thu, Dec 28, 2023 at 09:26:01PM +0530, Rajesh Pandian wrote:
> ---

Missing commit message.

>  man3/dl_iterate_phdr.3 | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/man3/dl_iterate_phdr.3 b/man3/dl_iterate_phdr.3
> index 0a8beb3ae..f47fdd502 100644
> --- a/man3/dl_iterate_phdr.3
> +++ b/man3/dl_iterate_phdr.3
> @@ -129,7 +129,9 @@ The
>  .I dlpi_phnum
>  field indicates the size of this array.
>  .P
> -These program headers are structures of the following form:
> +The ELF program header is described by the type Elf32_Phdr 
> +or Elf64_Phdr depending on the architecture.

Please use semantic newlines.

$ 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.

In this case, I'd break the line between 'by' and 'the', or maybe before
'depending'; whichever you prefer.

Cheers,
Alex

> +Following is an example of 32 bit architecture:
>  .P
>  .in +4n
>  .EX
> -- 
> 2.39.2
> 

-- 
<https://www.alejandro-colomar.es/>
Looking for a remote C programming job at the moment.

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

      parent reply	other threads:[~2024-01-01 11:56 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-12-28 15:56 [PATCH] bugzilla_218018 Rajesh Pandian
2023-12-28 22:43 ` Tom Schwindl
2023-12-29  3:19   ` rajesh
2024-01-01 12:00     ` Alejandro Colomar
2024-01-01 11:56 ` Alejandro Colomar [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=ZZKoWlGumW-0cGJN@debian \
    --to=alx@kernel.org \
    --cc=linux-man@vger.kernel.org \
    --cc=r.pandian@gmail.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