Date:   Fri, 17 Mar 2023 15:22:28 +0700
From:   Bagas Sanjaya <bagasdotme@gmail.com>
To:     Randy Dunlap <rdunlap@infradead.org>,
        Alexey Dobriyan <adobriyan@gmail.com>,
        akpm@linux-foundation.org
Cc:     linux-kernel@vger.kernel.org,
        Linux Doc Mailing List <linux-doc@vger.kernel.org>,
        Jonathan Corbet <corbet@lwn.net>
Subject: Re: [PATCH] ELF: document some de-facto PT_* ABI quirks
Message-ID: <ZBQjRLiXOwfmoIs+@debian.me>
References: <2acb586c-08a9-42d9-a41e-7986cc1383ea@p183>
 <e262ea00-a027-9073-812e-7e034d75e718@infradead.org>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
        protocol="application/pgp-signature"; boundary="xx//7xiLGuGFtrC6"
Content-Disposition: inline
In-Reply-To: <e262ea00-a027-9073-812e-7e034d75e718@infradead.org>
Precedence: bulk


--xx//7xiLGuGFtrC6
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Tue, Mar 14, 2023 at 07:34:11PM -0700, Randy Dunlap wrote:
> Hi,
>=20
> [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:
>=20
> =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D
> ELF header usage in Linux
> =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D

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.

>=20
> (I just made that up. Feel free to change it. :)
>=20
> 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.

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

--xx//7xiLGuGFtrC6
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iHUEABYKAB0WIQSSYQ6Cy7oyFNCHrUH2uYlJVVFOowUCZBQjPwAKCRD2uYlJVVFO
owcuAP4lDPdQVO6AVHUCej5SAiOUSoMlyrGjiEIDl26TaprLNgD+K4PvtF55ZbCc
XjJzxMW1l5SXOEdmoWt8jltxCwrvWAg=
=eLk5
-----END PGP SIGNATURE-----

--xx//7xiLGuGFtrC6--