Page MenuHomeFreeBSD

Convert the USES table into multiple <sect1>.
ClosedPublic

Authored by mat on Jul 21 2015, 1:30 PM.
Tags
None
Referenced Files
Unknown Object (File)
Dec 20 2023, 12:59 AM
Unknown Object (File)
Nov 20 2023, 9:23 PM
Unknown Object (File)
Nov 10 2023, 4:55 AM
Unknown Object (File)
Nov 8 2023, 12:25 PM
Unknown Object (File)
Nov 7 2023, 7:44 AM
Unknown Object (File)
Nov 5 2023, 4:46 PM
Unknown Object (File)
Oct 31 2023, 7:05 PM
Unknown Object (File)
Oct 10 2023, 8:24 PM
Subscribers
None

Diff Detail

Repository
rD FreeBSD doc repository - subversion
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

mat retitled this revision from to Convert the USES table into multiple <sect1>..
mat updated this object.
mat edited the test plan for this revision. (Show Details)
mat added reviewers: wblock, gjb.

Mostly just looked at the introduction. I like this in some ways, but I liked the compactness of the table version, too. The html-split version of this only has a table of contents at the very start. It's probably fine, though.

en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml
33 ↗(On Diff #7137)

Probably should not phrase this as a question. Maybe just

USES Values
or
USES Macros
or
Simplifying Ports with USES Macros

35 ↗(On Diff #7137)

Should be "USES macros" or "USES values" or something like that.

<para><varname>USES</varname> macros make it easy to declare requirements and settings for a port.

37 ↗(On Diff #7137)

Britishm->Americanism:
s/behaviour/behavior/

Good, but "and so on." is preferred to "etc." Nice to also point out it is easier than doing it manually:

...add metadata to packages, and so on, all by selecting simple, preset values.

mat marked 2 inline comments as done.Jul 22 2015, 11:07 AM
In D3142#62662, @wblock wrote:

Mostly just looked at the introduction. I like this in some ways, but I liked the compactness of the table version, too. The html-split version of this only has a table of contents at the very start. It's probably fine, though.

I liked the compact table, but it was getting bigger and bigger, and I did not like the way it was growing.
I don't really like the fact that in the html-split version there's now only one USES, but it's a rendering problem, not a documentation problem. Maybe there could be some new metadata added to the chapter telling it to not split itself into 60+ sub-sections.

en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml
33 ↗(On Diff #7137)

Yes, but, the title of the chapter is already Values of USES, this sect1 being an introduction on what this is, and how to use it, I wanted something more catchy. Or at least, different from the chapter's title.

37 ↗(On Diff #7137)

Damn, I wrote behavior, and replaced it with behaviour thinking it was the en_US way, I'll try to remember it.

mat marked an inline comment as done.
mat edited edge metadata.
  • Reword first §.
mat marked an inline comment as done.Jul 22 2015, 11:08 AM
en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml
33 ↗(On Diff #7172)

Using USES Macros
An Introduction to USES
Simplifying Ports with USES

If you want to keep it in the form of a question, add a question mark to the original:
What Are USES?

But it's not really a question/answer format.

mat marked 3 inline comments as done.Jul 23 2015, 11:52 AM
  • Rename the chapter's title, and the first section's.
wblock edited edge metadata.

Please remember to check with igor and build-test before commit. Thanks!

This revision is now accepted and ready to land.Jul 23 2015, 2:03 PM
This revision was automatically updated to reflect the committed changes.