Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 340333 - Confusing references to subsubsections
Summary: Confusing references to subsubsections
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Hosted Projects
Classification: Unclassified
Component: PMS/EAPI (show other bugs)
Hardware: All Linux
: High minor (vote)
Assignee: PMS/EAPI
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-10-10 11:53 UTC by Martin von Gagern
Modified: 2016-05-11 20:10 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments
suggested PMS patch (0001-Enumerate-subsubsections-but-don-t-include-them-in-t.patch,730 bytes, patch)
2010-11-01 11:16 UTC, Ulrich Müller
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Martin von Gagern 2010-10-10 11:53:32 UTC
I noticed that pms-3.pdf has some broken references. In particular, section 9.2.4 has three references to itself. I assume that latex wasn't run often enough when generating this document. A revbump fixing this would be great.
Comment 1 Martin von Gagern 2010-10-10 13:28:32 UTC
OK, my error: the referenced information really follows later on in that same section. Still, referencing it by number is somewhat confusing. Better wording or different sectioning would be good. Not a compilation issue, though, but an editorial issue.
Comment 2 Jeroen Roovers (RETIRED) gentoo-dev 2010-10-12 17:46:58 UTC
This should probably go upstream.
Comment 3 Ulrich Müller gentoo-dev 2010-10-12 18:19:39 UTC
Also several times in section 12.3.3 "Ebuild-specific Commands".

The problem is that subsubsections don't have numbers, therefore references to them appear as the number of the containing subsection.
Comment 4 Christian Faulhammer (RETIRED) gentoo-dev 2010-10-18 09:39:17 UTC
(In reply to comment #3)
> Also several times in section 12.3.3 "Ebuild-specific Commands".
> 
> The problem is that subsubsections don't have numbers, therefore references to
> them appear as the number of the containing subsection.

 We could enumerate subsubsections...Comments?
Comment 5 Ulrich Müller gentoo-dev 2010-10-18 16:40:26 UTC
(In reply to comment #4)
>  We could enumerate subsubsections...Comments?

Yes, we could increase secnumdepth from 2 to 3, but do we really want section numbers with four components? (I've no better idea though.)

Comment 6 Martin von Gagern 2010-10-18 17:29:17 UTC
One alternative would be page numbers instead or in addition to section numbers. Another would be restructuring the hierarchy to make do with less depth. Dunno.

I don't mind deep section numbers in such technical documents, though. Makes referencing parts easier while representing complicated structures sensibly.
Comment 7 Ulrich Müller gentoo-dev 2010-11-01 11:16:15 UTC
Created attachment 252791 [details, diff]
suggested PMS patch

We could increase secnumdepth to 3, but leave tocdepth at 2, in order not to clutter the table of contents too much. See attached patch. Or we could also increase tocdepth to 3.

Resulting PDF files with tocdepth 2 and 3 are here:
<http://dev.gentoo.org/~ulm/pms/pms-tocdepth-2.pdf>
<http://dev.gentoo.org/~ulm/pms/pms-tocdepth-3.pdf>

I'd prefer the first variant. Other opinions?
Comment 8 Christian Faulhammer (RETIRED) gentoo-dev 2010-11-01 11:50:37 UTC
(In reply to comment #7)
> We could increase secnumdepth to 3, but leave tocdepth at 2, in order not to
> clutter the table of contents too much. See attached patch. Or we could also
> increase tocdepth to 3.

 We can also have two table of contents with different verbosity levels, but for such a short document as PMS this is a bit overkill.  I vote for tocdepth 2 and secnumdepth 3.
Comment 9 Ulrich Müller gentoo-dev 2010-11-10 17:16:51 UTC
Nobody has objected, therefore pushed to master.

Thank you for pointing this out.
Comment 10 Ulrich Müller gentoo-dev 2016-05-06 13:59:01 UTC
In the mean time, subsection 11.3.3 "Ebuild-specific Commands" has grown to 14 pages. This is longer than any chapter (except for chapter 11, of course). Also, pointing to specific commands would have been useful more than once in the past.

Any objections if I increase the tocdepth to 3, i.e. the same value as secnumdepth? It would add one page to the PDF file.
Comment 11 Ulrich Müller gentoo-dev 2016-05-11 20:10:37 UTC
(In reply to Ulrich Müller from comment #10)
> Any objections if I increase the tocdepth to 3, i.e. the same value as
> secnumdepth?

Seems not. Committed to master:
https://gitweb.gentoo.org/proj/pms.git/commit/?id=1afb71f3cdeb145999c872c30e97a4a00ef6575b