[pacman-dev] Man pages (and a quick ML note)
Hey guys, I've been working on the manpages a lot in the past day or two, and I believe they are pretty up to date now with the changes that have been made. I'd appreciate people looking them over, giving me some (constructive) criticism, and pointing anything out that needs changing, updating, or a typo fixed, etc. If it is small, just send an email telling me what needs fixing, if large, feel free to submit a patch (but if you are unfamiliar with the man page format, then just describe the change and I'll implement it). On a side note, if the topic of a thread changes on the ML, can you guys update the subject before you reply? That way talk about bug #4744 doesn't end up in the bug #5775 thread, and makes keeping track of multiple topics a lot easier. -Dan
I will change the topic next time. Sorry for this... I don't know what the documentation includes, but i'll try to get the time to read over it for typos tonight when i come home from cinema or tomorrow ... have been 11 hours at work now anyway. Kind regards, Georg On 2/9/07, Dan McGee <dpmcgee@gmail.com> wrote:
Hey guys,
I've been working on the manpages a lot in the past day or two, and I believe they are pretty up to date now with the changes that have been made. I'd appreciate people looking them over, giving me some (constructive) criticism, and pointing anything out that needs changing, updating, or a typo fixed, etc. If it is small, just send an email telling me what needs fixing, if large, feel free to submit a patch (but if you are unfamiliar with the man page format, then just describe the change and I'll implement it).
On a side note, if the topic of a thread changes on the ML, can you guys update the subject before you reply? That way talk about bug #4744 doesn't end up in the bug #5775 thread, and makes keeping track of multiple topics a lot easier.
-Dan
_______________________________________________ pacman-dev mailing list pacman-dev@archlinux.org http://www.archlinux.org/mailman/listinfo/pacman-dev
On 2/9/07, Georg Grabler <ggrabler@gmail.com> wrote:
I will change the topic next time. Sorry for this...
Don't worry too much, it was just a helpful suggestion. :)
I don't know what the documentation includes, but i'll try to get the time to read over it for typos tonight when i come home from cinema or tomorrow ... have been 11 hours at work now anyway.
Thanks. Don't stress yourself out doing it though, sleep can be much more important. -Dan
On 2/9/07, Dan McGee <dpmcgee@gmail.com> wrote:
I've been working on the manpages a lot in the past day or two, and I believe they are pretty up to date now with the changes that have been made. I'd appreciate people looking them over, giving me some (constructive) criticism, and pointing anything out that needs changing, updating, or a typo fixed, etc. If it is small, just send an email telling me what needs fixing, if large, feel free to submit a patch (but if you are unfamiliar with the man page format, then just describe the change and I'll implement it).
Great work, by the way. Documentation is always one of those pain-in-the-assy things that always needs to be done. Thanks a lot.
On Friday 09 February 2007 18:10:07 Dan McGee wrote:
Hey guys,
I've been working on the manpages a lot in the past day or two, and I believe they are pretty up to date now with the changes that have been made. I'd appreciate people looking them over, giving me some (constructive) criticism, and pointing anything out that needs changing, updating, or a typo fixed, etc. If it is small, just send an email telling me what needs fixing, if large, feel free to submit a patch (but if you are unfamiliar with the man page format, then just describe the change and I'll implement it).
On a side note, if the topic of a thread changes on the ML, can you guys update the subject before you reply? That way talk about bug #4744 doesn't end up in the bug #5775 thread, and makes keeping track of multiple topics a lot easier.
-Dan
_______________________________________________ pacman-dev mailing list pacman-dev@archlinux.org http://www.archlinux.org/mailman/listinfo/pacman-dev
Which files you exactly updated? I just looked trough the pacman.8 file. No typos found at all, just found some ... unclear explaination and some things which did not sound well in my opinion. File attached for comparison with the original one, even though i'm not sure what you changed in the documentation today in the morning checkin. I'll take a look at more tomorrow and sunday. A very impressive work you've done there, quite a lot of documentation. Kind regards, Georg
On 2/9/07, Georg Grabler <ggrabler@gmail.com> wrote:
Which files you exactly updated?
I don't know if you knew, but you can use ViewCVS on our repository, allowing you to easily see the logs of each file and side-by-side diffs. Here is that link: <http://cvs.archlinux.org/cgi-bin/viewcvs.cgi/?cvsroot=Pacman>
I just looked trough the pacman.8 file. No typos found at all, just found some ... unclear explaination and some things which did not sound well in my opinion.
File attached for comparison with the original one, even though i'm not sure what you changed in the documentation today in the morning checkin.
The file you attached looks a lot like the old pacman.8 manpage. If this is what you were reading, I did go through the newer version and at least cleaned up what I thought was unclear. -Dan
On Friday 09 February 2007 23:49:44 Dan McGee wrote:
On 2/9/07, Georg Grabler <ggrabler@gmail.com> wrote:
Which files you exactly updated?
I don't know if you knew, but you can use ViewCVS on our repository, allowing you to easily see the logs of each file and side-by-side diffs. Here is that link: <http://cvs.archlinux.org/cgi-bin/viewcvs.cgi/?cvsroot=Pacman>
I just looked trough the pacman.8 file. No typos found at all, just found some ... unclear explaination and some things which did not sound well in my opinion.
File attached for comparison with the original one, even though i'm not sure what you changed in the documentation today in the morning checkin.
The file you attached looks a lot like the old pacman.8 manpage. If this is what you were reading, I did go through the newer version and at least cleaned up what I thought was unclear.
-Dan
_______________________________________________ pacman-dev mailing list pacman-dev@archlinux.org http://www.archlinux.org/mailman/listinfo/pacman-dev
Hello, Yes, the file is pretty much the same, i've read it and just corrected some. I'm not about to rewrite your documentation, just to point out what should be changed of my point of view. Shall just be another opinion, i'm aware of you checking back what i actually wrote. I thought you will use diff or similar to review what i actually changed. Cervisia is also fine to see which files have been updated. Don't expect too much, i'm just reviewing, and the documentation of pacman was quite fine so far. Kind regards, Georg
participants (3)
-
Aaron Griffin
-
Dan McGee
-
Georg Grabler