Page MenuHomeFreeBSD

Porter Handbook: document Uses/cabal.mk
ClosedPublic

Authored by arrowd on Feb 24 2020, 5:30 PM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, Apr 12, 3:25 AM
Unknown Object (File)
Thu, Apr 11, 2:04 PM
Unknown Object (File)
Mon, Apr 8, 12:17 AM
Unknown Object (File)
Dec 22 2023, 11:16 PM
Unknown Object (File)
Dec 16 2023, 7:16 PM
Unknown Object (File)
Nov 24 2023, 8:40 AM
Unknown Object (File)
Nov 19 2023, 10:14 AM
Unknown Object (File)
Nov 19 2023, 9:43 AM
Subscribers

Details

Diff Detail

Repository
rD FreeBSD doc repository - subversion
Lint
No Lint Coverage
Unit
No Test Coverage
Build Status
Buildable 29590
Build 27451: arc lint + arc unit

Event Timeline

I found a few things, but having this in the porters handbook is good.

en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
1336

The indentation here is wrong. The <sect2 needs to be aligned below the </sect2> above (with an empty line in between).

1342

I think the space here before the / is not necessary.

1374

Is the / here before the </screen> really part of the output?

1394

avoid the use of "we". Instead, simply write: "Once done, a list of files required dependencies can be generated:"

1403

You can enclose the .cabal in <filename> tags.

1406

Remove the "we can" here: "..., run the following command:"

1414

Enclose the _ in <literal> tags.

7214

This seems like to break the line too early. You can fill it up until 70 - 75 characters per line.

en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml
256

s/provides following/provides the following/

265

Enclose them in <literal> or <varname> tags and put the 0.1.2 in <replaceable> tags.

267

wrap the _ in <literal> and put a "the" before it: "the _ symbol."

277

program is superfluous, as the <command> tags show what it is.

277

s/during configuring/during the configuring/

323

superfluous option (change the <literal> to <option> to make it clear).

arrowd marked 13 inline comments as done.

Address comments.

arrowd marked an inline comment as not done.Mar 11 2020, 7:42 AM

Bump.

en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
1374

Yes, it is. I can remove it, if it gets in the way.

Could you ask on the freebsd-ports@ mailing list for a final round of reviews? This looks like a nice addition to the PH. Let's see if the community has any feedback on that.

@bcr, is the DocBook part alright?

@mat, should we wait for your review?

en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
1341

How about s/define/defines ?

The DocBook parts look good to me.

crees added a subscriber: crees.

I have a comment on the MAINTAINER line, but agree with @bcr.

en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
1359

MAINTAINER= # put your email address here

Unless haskell@ is happy to have extra ports dropped on them!

This revision was not accepted when it landed; it landed in state Needs Review.Mar 27 2020, 7:18 PM
This revision was automatically updated to reflect the committed changes.
arrowd marked an inline comment as done.