Updating fcpgenkey, fcpinvertkey man pages to 0.2.5 #10
Conversation
Soliloque
changed the title
|
Ooh, getting rid of those HTML versions will be nice. Some of these commit messages do not meet the commit message standards. Could you please update them? |
|
Done. |
| @@ -2,5 +2,5 @@ The PyFCP applications and library were written | |||
| by David McNab (aum) in May-June, 2006. | |||
|
|
|||
| Contact the author at: | |||
| david@freenet.org.nz | |||
| david@rebirthing.co.nz | |||
There was a problem hiding this comment.
Where did this email come from?
There was a problem hiding this comment.
From the man pages. Then I checked http://rebirthing.co.nz in search of this email adress. Did not find it but find a picture of David McNab on the first page. I write him to be certain. No reply yet but I did not receive any error. So this email is most probably working.
There was a problem hiding this comment.
I wonder if David still wants to be listed as maintainer for this codebase. I suspect not.
|
The way the author sections are written makes it sound like this was written in one go in 2006, and hasn't been changed since, which isn't the case. Any ideas on how to avoid that? |
|
It was spelt wrong. ;) |
|
I'm sorry, these still don't meet the commit message standards. Are they unclear? I'd like to clarify them - any suggestions? For example, in Commit summaries (meaning the first line) should not end with a full stop. The rest are not imperative - meaning commands to the codebase:
Thanks! |
|
English isn't my native language. The PyFCP applications and library were originaly written by David McNab (aum) in May-June, 2006 and are maintained by the Freenet Project team. |
Replace the name of SYNTAX sections by the universally standard SYNOPSIS.
Update fcpgenkey's man page with current supported options and apply some cosmetic changes.
|
Alright - sorry about that. Would you like me to merge once the content looks good and fix the commit messages where necessary? That sounds good for the authors section. originaly -> originally. (I assume you plan to do the pyFCP -> pyFreenet later?) |
Add a new REPORTING BUGS section to all man pages with information from the BUGS file in lib-pyFreenet's root directory.
|
Answering to a lot of things at once.
|
Expand AUTHORS sections in all man pages with information from the AUTHORS file in lib-pyFreenet root directory. Correct the original author's email with the one he provided.
Update fcpinvertkey's man page with the options supported by the current version of the software. Make a few cosmetic change.
Update the email of the original author with the one he instructed me to use. Cite the current maintainers.
|
I think it begins to look good. Please notice the last commit and the ones about AUTHORS and email. |
| .LP | ||
| USK@ are really just a user-friendly wrapper around SSK@, which hide | ||
| the process of searching for more recent versions of a site. Any | ||
| address written using an SSK@ key can also be written using an USK@ |
There was a problem hiding this comment.
This way isn't strictly correct, but the other way is. Any USK can be written as an SSK, but not every SSK can be written as a USK.
There was a problem hiding this comment.
I agree. I'll reverse it.
| .TP | ||
| .B | ||
| Syntax of SSK@ key: | ||
| SSK@<key>/<name_of_site>-<version#>/ |
There was a problem hiding this comment.
How about the USK goes first and then the SSK is "Syntax of equivalent SSK@ key:"? SSKs don't have to be formatted that way.
Add a discussion about the sameness of USK and SSK keys into the manpage for fcpgenkey as this is one of the things I found harder to understand as a newbie.
|
Looks good, thanks! |
|
Thank you for your patience. Should I notify you next time I do a pull request? |
|
No worries! :) Up to you - I should get an email, but if it looks like I've forgotten feel free to poke me about it. |
Then a few cosmetic changes and modifying other man pages to keep those uniform.
Removed html version of man pages as those are
Valided original author's email adress.