Re: [PATCH] ELF: document some de-facto PT_* ABI quirks

From: Bagas Sanjaya
Date: Fri Mar 17 2023 - 04:23:23 EST


On Tue, Mar 14, 2023 at 07:34:11PM -0700, Randy Dunlap wrote:
> Hi,
>
> [adding linux-doc for other interested parties]

Unfortunately akpm had already applied this doc as 60b38b7cbb295d ("ELF:
document some de-facto PT_* ABI quirks") while it being reviewed and
doesn't have any consensus yet.

> And could the document have a title, like:
>
> =========================
> ELF header usage in Linux
> =========================

The current doc path is Documentation/ELF/ELF.rst, which means that
readers expect to find general info about the executable format, not
some sort of trivia/niche like this.

>
> (I just made that up. Feel free to change it. :)
>
> Also, the .rst file should be added to some chapter in the current
> documentation tree, such as under "Other documentation", so add this file name
> to Documentation/staging/index.rst. In fact this file could live in
> Documentation/staging instead of in Documentation/ELF/ (IMO of course).

If there are more ELF docs there then a separate directory may be
warranted.

Thanks.

--
An old man doll... just what I always wanted! - Clara

Attachment: signature.asc
Description: PGP signature