1. Forum
  2. Usenet
  3. LINUX.GENTOO.DEV

  • Re: [gentoo-dev] [PATCH] linux-info.eclass: Documentation updates

    From Ulrich Mueller@21:1/5 to All on Sun May 15 09:30:01 2022
    On Sun, 15 May 2022, Mike Pagano wrote:

    +# @FUNCTION: check_zlibinflate
    +# @DESCRIPTION:
    +# helper function to make sure a ZLIB_INFLATE configuration
    +# has the requried symbols

    s/requried/required/

    Also, eclass-to-manpage will format won't respect the line breaks but
    format @DESCRIPTION as a paragraph, so there should be a full stop at
    the end of the sentence.

    +# See https://bugs.gentoo.org/27882
    check_zlibinflate() {
    if ! use kernel_linux; then
    die "${FUNCNAME}() called on non-Linux system, please fix the ebuild"

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

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

    iQFDBAEBCAAtFiEEtDnZ1O9xIP68rzDbUYgzUIhBXi4FAmKAqzsPHHVsbUBnZW50 b28ub3JnAAoJEFGIM1CIQV4ubsUH/iqaxP0OM7i7/LYtpcJHFhnwI+cGNRWI2WNT LpVoIDFpWcowHFgk+IzU2Vv4KTvyoeEANdCNpU3Y3z0fm9w1wmHlglDIG19rQk5K dJbrfJCjrynX6OAwNOAE3Bk6iI8WS/q8EzQRktUdgwtJgceuYMRT237yDdtk17mv wxUZHHxJd2VzZ4D8Sb3ZLzu4xKEBMmWg570/GKqf9U5N4zzA5kVsAx2BXEPOyGst kb+D6ZINg2Yq6AvTsu51fbNGK7iNOZThM4DxVvN4MV7Ke7kBWYrWhupGQm/IRjw+ 4d46iqmyObQTLNh2/oDjVq1yvqp4uZw53QyWnoP/QR3sF2vwkZI=wJL3
    -----END PGP SIGNATURE-----

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Usenet Gateway (21:1/5)
  • From Ulrich Mueller@21:1/5 to All on Sun May 15 09:40:01 2022
    On Sun, 15 May 2022, Ulrich Mueller wrote:

    On Sun, 15 May 2022, Mike Pagano wrote:
    +# @FUNCTION: check_zlibinflate
    +# @DESCRIPTION:
    +# helper function to make sure a ZLIB_INFLATE configuration
    +# has the requried symbols

    s/requried/required/

    Also, eclass-to-manpage will format won't respect the line breaks but
    format @DESCRIPTION as a paragraph,

    Sorry, seems that I wasn't awake yet when writing this. The sentence
    should read:

    eclass-to-manpage won't respect the line breaks but will format
    @DESCRIPTION as a paragraph,

    so there should be a full stop at the end of the sentence.

    +# See https://bugs.gentoo.org/27882
    check_zlibinflate() {
    if ! use kernel_linux; then
    die "${FUNCNAME}() called on non-Linux system, please fix the ebuild"

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Usenet Gateway (21:1/5)
  • From Thomas Bracht Laumann Jespersen@21:1/5 to All on Mon May 16 21:20:01 2022
    +# @FUNCTION: qout
    +# @DESCRIPTION:
    +# qout <einfo | ewarn | eerror> is a quiet call when EBUILD_PHASE
    # should not have visible output.

    The devmanual says that @USAGE is also required for eclass functions [0]. This is applicable in a few cases, I'm just highlighting one here.

    OTOH lots of eclass functions have left out @USAGE, and the tooling around html/man page generation also appears to treat it as optional. So it could be that the devmanual is wrong here.

    -- Thomas

    [0]: https://devmanual.gentoo.org/eclass-writing/index.html#eclass-functions

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Usenet Gateway (21:1/5)
  • From Ulrich Mueller@21:1/5 to All on Mon May 16 22:00:03 2022
    On Mon, 16 May 2022, Thomas Bracht Laumann Jespersen wrote:

    +# @FUNCTION: qout
    +# @DESCRIPTION:
    +# qout <einfo | ewarn | eerror> is a quiet call when EBUILD_PHASE
    # should not have visible output.

    The devmanual says that @USAGE is also required for eclass functions
    [0]. This is applicable in a few cases, I'm just highlighting one
    here.

    @USAGE is required if the function accepts any arguments. This is
    similar to @RETURN, and is clear from the examples in [0]. For example, jmake_src_compile at the bottom of the page doesn't have a @USAGE line.

    OTOH lots of eclass functions have left out @USAGE, and the tooling
    around html/man page generation also appears to treat it as optional.

    Which is correct AFAICS.

    So it could be that the devmanual is wrong here.

    [0]: https://devmanual.gentoo.org/eclass-writing/index.html#eclass-functions

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

    iQFDBAEBCAAtFiEEtDnZ1O9xIP68rzDbUYgzUIhBXi4FAmKCrQcPHHVsbUBnZW50 b28ub3JnAAoJEFGIM1CIQV4u0lwIANutOpRvUKV0zt13I7+5SHO6m2xS41pGZKNH Fwd6ABaVwBp5SmifY6ipqi/TxftDk9Mxnf2w7nEKoq3QDToh8anzQzNtcPSm25nH cUtJ88GlS0eNz8wU8gNnH689vAPALJLJ++ZVQnnm3VuGaIOBPUeRu+a77QolCADa PscsjkSKxcxVlFgh9aMYJ3X+eIHrFS3Je+dTmJD4l3t/d2uc3pKH1FApjOKKHhHa rXovfTCmne6I867FX0F+EXrTM0LrRAX7pJSNe+OHCms6SoXfnUUHGrxp6N19uAvb 48lIrhA6ED23is9F6Ob/+5K6uRx/V18/3bSefXPC9xKdunVjypA=
    =rugm
    -----END PGP SIGNATURE-----

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Usenet Gateway (21:1/5)
  • From Mike Pagano@21:1/5 to Sam James on Tue May 17 01:10:01 2022
    On 5/16/22 18:57, Sam James wrote:


    On 14 May 2022, at 23:59, Mike Pagano <mpagano@gentoo.org> wrote:

    Document functions which did not have any
    documentation or was not formatted to gentoo
    specifications

    Signed-off-by: Mike Pagano <mpagano@gentoo.org>
    ---
    eclass/linux-info.eclass | 38 ++++++++++++++++++++++++++++++++++----
    1 file changed, 34 insertions(+), 4 deletions(-)
    [snip]

    Just wanted to say thanks for putting the work in on eclassdocs and the other bits
    you've been doing with the eclasses recently.

    Cheers!


    Thanks, Sam. You are the perfect representation of how collaboration in Gentoo can be great.

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Usenet Gateway (21:1/5)
  • From Sam James@21:1/5 to All on Tue May 17 01:00:01 2022
    On 14 May 2022, at 23:59, Mike Pagano <mpagano@gentoo.org> wrote:

    Document functions which did not have any
    documentation or was not formatted to gentoo
    specifications

    Signed-off-by: Mike Pagano <mpagano@gentoo.org>
    ---
    eclass/linux-info.eclass | 38 ++++++++++++++++++++++++++++++++++----
    1 file changed, 34 insertions(+), 4 deletions(-)
    [snip]

    Just wanted to say thanks for putting the work in on eclassdocs and the other bits
    you've been doing with the eclasses recently.

    Cheers!

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

    iQGTBAEBCgB9FiEEYOpPv/uDUzOcqtTy9JIoEO6gSDsFAmKC1vdfFIAAAAAALgAo aXNzdWVyLWZwckBub3RhdGlvbnMub3BlbnBncC5maWZ0aGhvcnNlbWFuLm5ldDYw RUE0RkJGRkI4MzUzMzM5Q0FBRDRGMkY0OTIyODEwRUVBMDQ4M0IACgkQ9JIoEO6g SDtOhwf+IvqDi3fvEpOEY4hQYZFzaFVAnsQt5/q9flcK5v+Wb9SYHhHe/9gRxC10 Gvfft823VrsJmSkUbS56F5X7ui5qD8YsR0tPZhtjCPXIbf49Lr+h6crDfL17cYuD bvc2BBgWwhxeeUmr2oVfje+/UU+nyrlyTmCwyeYyQZcIzKvG9QzDv9yOo+hjLPue JdZMfNSc7D0BkqRn+xU26insJsrpUY+gxvm0SC+B9OmZxDGwgpWhRyme6Q2nLXFS Cl8tM4q670ndXpvlFs3JQp79vJkID4PiGouuhqvsI6IVQ9nGXmp53XUT8n3yyIFU SWj6bRj30aIoURjQV1H3NchLwyc4iA==
    =fsLh
    -----END PGP SIGNATURE-----

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Usenet Gateway (21:1/5)