Page MenuHomeFreeBSD

Document BINARY_ALIAS in the Porter's Handbook
ClosedPublic

Authored by tobik on Jun 5 2018, 11:11 AM.
Tags
None
Referenced Files
Unknown Object (File)
Sat, Jan 18, 1:05 AM
Unknown Object (File)
Fri, Jan 17, 3:28 PM
Unknown Object (File)
Wed, Jan 15, 3:59 AM
Unknown Object (File)
Dec 6 2024, 9:43 PM
Unknown Object (File)
Oct 13 2024, 10:14 PM
Unknown Object (File)
Oct 6 2024, 6:53 AM
Unknown Object (File)
Aug 24 2024, 5:02 PM
Unknown Object (File)
Aug 23 2024, 7:39 AM
Subscribers
None

Details

Summary
Document BINARY_ALIAS in the Porter's Handbook

Approved by:	?
Differential Revision:	https://reviews.freebsd.org/D?????

Probably it's in the wrong section right now. Maybe it should be under 5.9 Dependencies or in Chapter 6 instead?

Diff Detail

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

Event Timeline

en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
8107

Missing a blank line before this.

8108

I think the section should have a more descriptive title, maybe something like:

Use BINARY_ALIAS to rename commands instead of patching the build

because otherwise, if you do not know what it does, you can't infer from the title.

8112

will be prepended to <varname>PATH</varname>.

8114–8116

Try to write in the active voice, not passive, and be more imperative.

Used to substitute hardcoded commands the build phrase rely
on without having to patch any files.
8124–8125

I think GNU sed can be an application, like:

Some ports expect <command>sed</command> to behave like 
<application>GNU sed</application> and use features that
&man.sed.1; does not provide.  <application>GNU sed</application>
is available from <package role="port">textproc/gsed</package> 
as <command>gsed</command> on &os;.
8127–8129

more imperative:

Use <varname>BINARY_ALIAS</varname>
to substitute <command>sed</command> with
<command>gsed</command> for the duration of the build:
8140

Some port is vague, you are giving a specific example, so write:

A port with a hard dependency on
8142–8143

Don't use can it is feeble, so, no We can use but simply Use.

8152

Remove blank line.

Also, you could add a pointer to this new section in the section about patching, as a <tip> for example.

Probably it's in the wrong section right now. Maybe it should be under 5.9 Dependencies or in Chapter 6 instead?

I think here is good, or maybe it should be in the section about patching.

tobik marked 9 inline comments as done.
  • Fix style
  • Add tip about BINARY_ALIAS to the Patching section
en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
8113

s/binaries/commands/ they could be scripts.

8114

I don't quite like the "prepended to PATH" it is too specific, but I cannot find a nicer way to say it.

8116–8117

Mmmm, Use it to ... it is strange this way.

8120–8121

The "replace" bit does not feel right, maybe something like:

Using <varname>BINARY_ALIAS</varname> to Have <varname>gsed</varname>
Available as <command>sed</command>
tobik marked 3 inline comments as done.

...

This revision is now accepted and ready to land.Jun 7 2018, 7:28 AM
This revision was automatically updated to reflect the committed changes.