From: Florian Weimer <fweimer@redhat.com>
To: Adhemerval Zanella Netto <adhemerval.zanella@linaro.org>
Cc: libc-alpha@sourceware.org
Subject: Re: [PATCH 2/3] manual: Document ld.so --list-diagnostics output
Date: Wed, 23 Aug 2023 08:33:57 +0200 [thread overview]
Message-ID: <87v8d6nu7e.fsf@oldenburg.str.redhat.com> (raw)
In-Reply-To: <1db73519-30a7-d631-6210-89ee05441140@linaro.org> (Adhemerval Zanella Netto's message of "Mon, 21 Aug 2023 13:24:34 -0300")
* Adhemerval Zanella Netto:
>> +Output lines can be parsed with the following Python function. It
>> +assumes lines formatted according to the ABNF @code{line} production
>> +above.
>
> I don't think it would be useful to add the python script example below,
> it is not an full example (reader will need to fill the blacks to actually
> run it) and he ABNF description should be suffice.
I'm going to remove it.
>> +As mentioned above, the set of diagnostics may change between
>> +@theglibc{} releases. Nevertheless, the following table documents a few
>> +common diagnostic items.
>> +
>> +@table @code
>> +@item dl_dst_lib=@var{string}
>> +The @code{$LIB} dynamic string token expands to @var{string}.
>
> s/to/to a
I think @var{string} as a variable should not have an article.
>> +
>> +@item dl_hwcap=@var{integer}
>> +@itemx dl_hwcap2=@var{integer}
>> +@cindex HWCAP (diagnostics)
>> +The HWCAP and HWCAP2 values, as returned for @code{getauxval}, and as
>> +used in other places depending on the architecture.
>> +
>> +@item dl_pagesize=@var{integer}
>> +@cindex page size (diagnostics)
>> +The system page size is @var{integer} bytes.
>
> Maybe add it is in hexadecimal.
I'm going to add a sentence to the introductory paragraph:
All numbers are in hexadecimal, with a @samp{0x} prefix.
I've applied the rest of your suggestions.
Thanks,
Florian
next prev parent reply other threads:[~2023-08-23 6:34 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-08-04 18:16 [PATCH 0/3] Document ld.so --list-diagnostics, add syntax tests Florian Weimer
2023-08-04 18:16 ` [PATCH 1/3] Linux: Avoid conflicting types in ld.so --list-diagnostics Florian Weimer
2023-08-21 16:02 ` Adhemerval Zanella Netto
2023-08-04 18:16 ` [PATCH 2/3] manual: Document ld.so --list-diagnostics output Florian Weimer
2023-08-04 23:33 ` Arsen Arsenović
2023-08-08 15:38 ` Florian Weimer
2023-08-21 16:24 ` Adhemerval Zanella Netto
2023-08-23 6:33 ` Florian Weimer [this message]
2023-08-04 18:16 ` [PATCH 3/3] elf: Check that --list-diagnostics output has the expected syntax Florian Weimer
2023-08-21 16:29 ` Adhemerval Zanella Netto
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=87v8d6nu7e.fsf@oldenburg.str.redhat.com \
--to=fweimer@redhat.com \
--cc=adhemerval.zanella@linaro.org \
--cc=libc-alpha@sourceware.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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).