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?
Details
Details
- Reviewers
mat - Commits
- rD51790: Document BINARY_ALIAS in the Porter's Handbook
Diff Detail
Diff Detail
- Repository
- rD FreeBSD doc repository - subversion
- Lint
No Lint Coverage - Unit
No Test Coverage - Build Status
Buildable 17044 Build 16907: 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. | |
Comment Actions
Also, you could add a pointer to this new section in the section about patching, as a <tip> for example.
Comment Actions
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.
| 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> | |