nss.texi patch for review

ricaljasan ricaljasan@pacific.net
Thu Sep 4 04:48:00 GMT 2014


I am preparing a patch for the glibc manual and would like to offer my
first attempt at revision for review. I've edited the manual/nss.texi
file. The diff was obtained from `git diff'. It appears to meet the
criteria in section 13 of
https://sourceware.org/glibc/wiki/Contribution%20checklist, but I wanted
to make sure that was OK.

There are some places where reading only the diff doesn't do the edits
justice, so I wanted to mention those. In "The NSS Configuration File"
section, the language was a little ambiguous to me. The word "action"
seemed to be used for a handful of things, so I tried to rearrange or
word things so they were clearer in context. In general, I tried to make
the language more consistent throughout the chapter.

There are some comments near the end of the diff which I expect to
remove before any commit; they are there for my reference at this time,
but I have left them in case somebody who reviews this knows the answer
to the questions within them. I'll be inspecting the source further to
see if I can answer them myself, but since this email is only intended
as a preliminary review, I thought it wouldn't hurt to leave them.

There are quite a few purely grammatical edits. I always appreciate
well-written documentation and I think (hope) most of them do contribute
to the document's clarity. I've tried not to add anything like
superfluous commas (but no guarantees, as those can be a matter of taste
- another aspect I hope to address with this review).

I believe I've dialed in Thunderbird to send mail according to the
specifications in the third point of section 13 of the the above URL. I
have sent myself some test messages to verify Content-Type is
text/x-patch and the Content-Disposition is inline rather than
attachment. The charset is only specified for the message body, but it
is utf-8. Let me know if anything was wrong.

I also have some questions about the overall process. Do I create a
Changelog entry or does the developer who approves and commits my patch?
Since a developer commits the patch, I don't have anything to do with
the git commit log, correct? Hopefully I'm understanding that much of
the procedure.

Lastly, the subject of the email doesn't conform to section 2 of the
above URL because I'm only posting this for review, but that will be
adjusted accordingly.

Thank you for taking the time to help.

Rical Jasan
-------------- next part --------------
A non-text attachment was scrubbed...
Name: nss.texi.diff
Type: text/x-patch
Size: 25101 bytes
Desc: not available
URL: <http://sourceware.org/pipermail/libc-help/attachments/20140904/39985b5d/attachment.bin>


More information about the Libc-help mailing list