On Mon, Jul 28, 2008 at 2:59 PM, Nagy Gabor <[EMAIL PROTECTED]> wrote:
>> Dan complained several times that the README file was long outdated,
>> so I tried to improve that.
>> I hope I did not make it worse :/
>> As always, help/feedback is appreciated.
>
> Wow. I like it, especially the API changes part ;-).
>
> I can see some formatting issues:
> -2 empty line between [REMOVED] and [CHANGED] sections
> -mix "-foo" and "- foo".
> -'.  After its call' in [Initialization] (2 space after .)
> -too long line(s?) (>80 chars): 45
> -and the most important: too long underline of API changes section. :-P
>
> Some more important comments (not affected by your patch):
> -A clear transaction work-flow is missing (with examples?):
> init, addtarget/sysupgrade, prepare, commit, release (commit is
> mentioned as an example of function naming only!)
> -alpm_list_t is not optional, like the README suggests you. Many alpm
> functions return with alpm_list_t.
>

I think I took care of all your comments, except the biggest one, "A
clear transaction work-flow..." which I kindly leave to you or anyone
else interested :)
Since it is indeed not affected by my patch, it can be an independent
improvement of the README.

Attachment: README
Description: Binary data

_______________________________________________
pacman-dev mailing list
[email protected]
http://archlinux.org/mailman/listinfo/pacman-dev

Reply via email to