As always, the current version is available at http://aragorn.in.absolight.net/d/en/b/ph/testing-poudriere.html
Diff Detail
Diff Detail
- Repository
- rD FreeBSD doc repository - subversion
- Lint
No Lint Coverage - Unit
No Test Coverage
Event Timeline
There are a very large number of changes, so older changes are hidden. Show Older Changes
Comment Actions
Ok, I think I got everything, I did not rewrap/reindent stuff to minimize the diff. (I will do it in the end, before committing everything.)
| en_US.ISO8859-1/books/porters-handbook/testing/chapter.xml | ||
|---|---|---|
| 258 | what about The examples in this chapter show a default file layout, as standard in &os;. ? | |
| 285 | Well, I did not write all this chapter, I only put xml around it 0:-) A ports committer would want to use the -devel because it's what is used in production, and has all the new bells and whistles, but a contributor would not need those, the most important fixes were backported. The main reason for the use of -devel to build the official package is because it is faster, but faster in a way that's important when you build the whole ports tree on a 32 cpu server because it'll take 17 hours instead of 18 hours, not faster enough to matter when you're building your ports on a desktop machine. I was wondering about the examples yesterday when I did a last pass on it to see what could be said better. But all in all, they would not change much, there may be a new field in the output here and there, but nothing someone porting software could not adapt to. | |
| 310 | Ah, being French, it's a bit hard to capitalize a normal noun. But you're right, maybe I should capitalize it when speaking of the application. I'll replace all occurrences. | |
| 323 | ZROOTFS=tank/poudriere but, yes, you're right, removing those. | |
| 354 | Yup, I noticed, but as I already added them all over the place... :-p | |
| 357 | Yes, the and if is not good, it could be replaced by only if, the idea is that if the jail has access to the internet, it needs to be able to do DNS and all to fetch the distfiles, but if it goes through a proxy, it doesn't need to do any DNS, it tells the proxy "go and fetch me http://example.com/bar.tar.gz" and the proxy will do all the DNS and fetching. I'll try to rewrite it a bit better. | |
| 369 | As opposed to using release tarballs and updating with freebsd-update. | |
| 385 | Oh, yes, I did not know how to link to the handbook, is that kind of linking ok, or is there a preferred way to do it ? | |
| 467 | I was wondering about the current branch if you too think it can be misread, I'll drop current :-) | |
| 490 | Mmmm, it is not a filename, it is a zfs filesystem, so using <literal> ? I've done it like that for all the chapter. (I just forgot this one it seems.) | |
| en_US.ISO8859-1/books/porters-handbook/testing/chapter.xml | ||
|---|---|---|
| 258 | The examples being talked about are in this section. The rest of the chapter applies to other things, so "in this section" is more appropriate. | |
| 285 | Instead of that last sentence ("It may be more useful than the regular one."), explain what you just said above. It just explains what "more useful" means. | |
| 296 | Good! But the comma after "file" is not needed. | |
| 361 | This is much better. I'd say "when using a proxy" rather than "if". | |
| 363 | Reads better with s/configuring a proxy/proxy configuration/ | |
| 369 | Right, but the current text does not say whether Subversion is being used to update source or ports. It should. | |
| 385 | The FDP shows links, but doc/share/xml/urls.ent has predefined entries. For this, use &url.books.handbook; | |
| 446 | Sorry, this was my fault. There should be no comma before "along". | |
| 454 | No comma. | |
| 467 | Agreed, use "revision in the branch." | |
| 493 | <application> tags. | |
| 519 | s/bulds/builds/ | |
| 520 | s/portsnap/&man.portsnap.8;/ | |
| 522 | s/Just akin/As with/ | |
| 530 | s/Will create/Creates/ | |
| 531 | <literal>tank/poudriere/ports/subversive</literal>, and mounts it | |
| 532 | on <filename>/poudriere/ports/subversive</filename>. It is then | |
| 533 | populated using... | |
| 534 | s/Again, afterwards it is included in/Finally, it is added to/ | |
| 547 | "enforces the checkout using ssh" is... odd. How about: "uses <application>SSH</application> for the checkout." | |
| 558 | s/local/a local/ | |
| 571 | s/column <literal>METHOD</literal>/<literal>METHOD</literal> column/ | |
| 610 | No comma. | |
| 611 | "with Poudriere with the command" is not needed. Just | |
| 616 | All dependencies of <application>Firefox</application> are built. | |
| 618 | pre-built packages are installed using the default options in jails. | |
| 619 | Then <application>Firefox</application> itself is built. | |
| 622 | "The complete build of every port is logged to..." | |
| 628 | "For convenience, a symbolic link to ... is also maintained." | |
| 631 | "The link points to the latest..." | |
| 632 | s/folder/directory/, both places. <filename> tags around index.html. | |
| 633 | s/via/with/ | |
| 635 | By default, <application>Poudriere</application> cleans up the jails and leaves log files in the directories mentioned above. To ease investigation, jails can be kept running after the build by adding <option>-i</option> to <command>testport</command>: | |
| 644 | After the build completes, and regardless of whether it was successful or not, a shell is provided within the jail. The shell is used to investigate further. (Is this only with -i, or always? It's not clear.) | |
| 647 | <application>Poudriere</application> can be told to leave the jail running after the build finishes with <option>-I</option>. | |
| 650 | I don't understand this sentence. "when finished the jail is no longer needed". I think it might mean: After finishing, the command to run is shown. | |
| 666 | "...the ability to tweak ports to personal preferences with options." | |
| 668 | Use <option> instead of <literal>. | |
| 672 | s/Will present/Presents/ (passive->active) Also, no comma. | |
| 673 | s/will still be/are still/ | |
| 674 | default options except the one given after <option>-o</option> in the format | |
| 692 | Use <emphasis> tags on "set". | |
| 696 | "This allows, for instance, usage of <command>testport</command> with non-standard options for" | |
| 699 | This whole sentence is a mystery. It's about three sentences long, "akin to" can be read to mean different things, and the "it" in "in its configuration directory" could be a number of things. Please break up and clarify. | |
| 749 | s/will nullfs-mount/nullfs-mounts/ | |
| 752 | s/will be/are/ | |
| 753 | <command> tags on testport. | |
| 755 | After the directory structure for a set is provided, the options for a particular port can be altered. For example: | |
| 761 | The configuration dialog for www/firefox is shown, and options can be edited. | |
| 763 | The selected options are saved to the <literal>devset</literal> set. | |
| 768 | s/configuration of options/option configuration/ | |
| 781 | s/will look/looks/ | |
| 787 | s/will cause/causes/ | |
| 858 | s/in any/by any/ | |
| en_US.ISO8859-1/books/porters-handbook/testing/chapter.xml | ||
|---|---|---|
| 618 | Hum, no, that is wrong.
But the packages are not installed with default options, it does not mean anything. | |
| 644 | It's only with -i, it's explained in the previous paragraph introducing the -i argument. | |
| 650 | makes way more sense if I remove "finished" :-) | |
| 699 | I have to say, I'm not exactly sure what @riggs wanted to say here, I'll let him explain 0:-) | |
| en_US.ISO8859-1/books/porters-handbook/testing/chapter.xml | ||
|---|---|---|
| 454 | Remove "can be used". | |
| 511 | Use <quote> tags. | |
| 519 | Remove ", as a ports contributor". | |
| 522 | And put it here: "...modifications for a ports contributor." | |
| 531 | Sorry, this comma can be removed also. | |
| 618 | This makes sense. Do it! | |
| 632 | s/directory there/directory/ | |
| 645 | s/or not// | |
| 649 | Use "display" or "show" rather than output, which is usually a noun. Also, <application> tags. | |
| 673 | Spelling: dependencies | |
| 676 | The remaining fragment needs work. The previous sentence and this one are trying to say that default options are used for all the ports except the one given with -o, which will use the custom options. And then it can show a <screen> example to show the format. | |
| 753 | Probably sufficient just to say "this run of <command>testport</command>". | |
| en_US.ISO8859-1/books/porters-handbook/testing/chapter.xml | ||
|---|---|---|
| 676 | I'm wondering if I should not remove this bit, or at least comment it, as -c has been broken since Poudriere 2.4... (the current release is 3.0, and the upcoming 3.1.0 is, I think, unlikely to fix this bit. | |
| 753 | I've been wondering about all these <command>testport</command> if it should not be <command>poudriere testport</command> because there is not testport command it's only an argument to poudriere | |
| en_US.ISO8859-1/books/porters-handbook/testing/chapter.xml | ||
|---|---|---|
| 676 | -c or -o? Either way, if it is not present, I'd say remove it. Commented code hangs around forever and is usually not useful. | |
| 753 | They are commands, or sub-commands, to poudriere. In context, I think the examples make it clear what is meant by just testport. | |
Comment Actions
From my point of view, it's a go! Thanks!
| en_US.ISO8859-1/books/porters-handbook/testing/chapter.xml | ||
|---|---|---|
| 699 | I simply wanted a condensed version of poudriere's man page, the paragraph "Custom build options" in the section "CUSTOMISATION". I appreciate better worded proposals, apparently my sentence is not very clear. | |