John Snow <[email protected]> writes: > This patch converts some slightly-non-trivial intros with more than > one paragraph, but doesn't create any new intro/details splits. > > Review notes: Again, the Numa Hmat options have text that are prime > candidates for a ".. seealso::" admonition, but I was uncertain as to > whether this information was principally for developers or for > users. If it's for developers, it can stay in the intro where it will > be dropped when inlined. If it is for users, they should be moved into > the details region.
I think it's for users. If I remember correctly, I complained in review that member descriptions are greek for the uninitiated like myself. The submitter pointed out that explaining them would involve duplicating much of the relevant spec document, so we agreed on adding a reference to that. > The remaining structs have an awful lot of text, but I was not > immediately sure of which information we wanted to preserve when > inlined or not; these structures tend to be written as if they are > describing a command, but they actually only define a set of > arguments. > > Advice? Opinions? When you're not sure whether certain contents is "intro" or "details", leave it in "plain", because "plain" we'll revisit for sure. Makes sense? > Signed-off-by: John Snow <[email protected]>
