Elaine: > Updated in the attached files accordingly. Please help me review the > revised ones then I can check them in.
Please just check the updates into SVN head and I'll provide review comments later. I can't review some of the changes from looking at the ASCII. Brian > Brian Cameron wrote: >> >> Elaine: >> >> Overall very well written. Some minor comments: >> >> - The "SEE ALSO" section should refer to "attributes(5)". >> >> - The "SEE ALSO" section should be in section # order, then >> alphabetical order (e.g. bar(1), foo(1), bar(3), foo(3)" >> transmission-remote(1) should come after transmission-proxy(1). >> >> - You use "bittorrent" and "BitTorrent" in the manpages. >> I think we should use one format or the other, but not >> a mix of both. >> >> - transmissioncli takes an OPERAND called "torrent.file" >> or "output-file", but there is no OPERAND section to describe >> them. >> >> - The transmissioncli page says this: >> >> -a, --announce announce-url >> >> Specifies the announce-url the new torrent will use. Can >> only be used in conjunction with -c or --create-from. >> >> Note that when you explain an argument (announce-url) you should >> use the same string in the description. You did this, but you >> should also surround the "announce-url" in the description with >> <replaceable> tags so it looks like: >> >> Specifies the <replaceable>announce-url</replaceable> the... >> >> Likewise: >> >> -m, --comment comment-text >> >> This optional parameter adds a comment to the new >> torrent. Can only be used in conjunction with -c or -- >> create-from. >> >> This should read something like "This option adds >> <replaceable>comment-text</replaceable> to the new torrent. >> >> The -o, --output-dir and -v, --verbose, -p --port, -u --upload, >> -d, --download options also need similar changes. >> >> Note the transmission-remote manpage has similar issues. >> >> - The transmissioncli manpage says: >> >> Prints the number of seeders and leechers for the speci- >> fied tor rent file, and exits. >> >> What does "seeders and leechers" mean. Would be good to explain >> these terms in the DESCRIPTION section. Also shouldn't that be >> "torrent" rather than "tor rent"? >> >> - The transmissioncli manpage says: >> >> -v, --verbose level >> >> Sets debugging options. You can use both many -v flags, >> or a -v level. >> >> That is confusing to me. What does "both many -v flags or a -v >> level" mean? >> >> - The transmission-proxy manpage says this: >> >> transmission-proxy [--type daemon | gtk] >> >> Should use <replaceable> tags around "daemon | gtk". Also in >> the OPTIONS section. The description for this option doesn't >> really explain why a user might want to connect to >> transmission-daemon(1) versus transmission(1). >> >> Note the transmission-remote manpage has similar issues where >> you don't use <replaceable> with options that use "|" >> >> - transmission-remote says "Add the torrent" for the -a option. >> Add the torrent to what? It also says "Remove the download >> limit" for the -D option. What is the default download limit? >> Likewise what is the default upload limit referenced in the -U >> option? What is the default port number if the -p option >> is not specified? >> >> What does "enable/disable peer exchange mean"? This manpage >> also refers to "seeders", might be good to explain this term >> in the DESCRIPTION. >> >> - The --transmission remote NAME section says: >> >> [--torrent.file ...] >> >> Should this be an operand? Are the dashes an error? If so >> this manpage should have an OPERANDS section. >> >> [...] >> command [--argument ...] >> >> Is command an operand? Again, if so, this manpage should have >> an OPERAND section. What does the [--argument ...] at the >> end mean? There is no argument called --argument that I can >> see described in this manpage. >> >> Brian >> >> >> >> >>> Author: elaine >>> Repository: /svn/jds/spec-files-other >>> Latest revision: 232 >>> Total changesets: 1 >>> Branch: trunk >>> Date: 2008-08-05 11:47:09 +0000 (Tue, 05 Aug 2008) >>> >>> Added files: >>> trunk/ext-sources/transmission-daemon.1 >>> trunk/ext-sources/transmission-proxy.1 >>> trunk/ext-sources/transmission-remote.1 >>> trunk/ext-sources/transmission.1 >>> trunk/ext-sources/transmissioncli.1 >>> Modified files: >>> trunk/ChangeLog >>> trunk/core/SUNWtransmission.spec >>> >>> Log message: >>> Add new manpages into the package. >>> >>> >>> ------------------------------------------------------------------------ >>> >>> U trunk/ChangeLog >>> U trunk/core/SUNWtransmission.spec >>> A trunk/ext-sources/transmission-daemon.1 >>> A trunk/ext-sources/transmission-proxy.1 >>> A trunk/ext-sources/transmission-remote.1 >>> A trunk/ext-sources/transmission.1 >>> A trunk/ext-sources/transmissioncli.1 >>
