John Byrd via llvm-dev
2019-Jun-13 19:20 UTC
[llvm-dev] Documentation cleanup review process?
Dear llvm-dev, As I've been working with llvm sources on a prototype backend, it seems to me that much of the documentation on llvm internals is, shall we say, wanting. (I'm looking at you particularly, tablegen.) I can clean up documentation issues and clarify in the .rst files as I'm learning, but the code submission process is silent on how documentation changes make it into master. At this point, even CODE_OWNERS.TXT is silent on who is responsible for the doc directory. Pointers would be helpful. Thank you very much. -- --- John Byrd Gigantic Software 2321 E 4th Street Suite C #429 Santa Ana, CA 92705-3862 http://www.giganticsoftware.com T: (949) 892-3526 F: (206) 309-0850 -------------- next part -------------- An HTML attachment was scrubbed... URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20190613/615ff8c3/attachment.html>
Sjoerd Meijer via llvm-dev
2019-Jun-13 19:42 UTC
[llvm-dev] Documentation cleanup review process?
I don't think documentation works much different than source-code. I.e., patches welcome, and you can always upload a diff for e.g. any of the .rst files in the doc directory. Usually good candidates for reviewers are people who last touched the same piece of code/text, which you can find out with a git/svn blame. Cheers, Sjoerd. ________________________________ From: llvm-dev <llvm-dev-bounces at lists.llvm.org> on behalf of John Byrd via llvm-dev <llvm-dev at lists.llvm.org> Sent: 13 June 2019 20:20 To: llvm-dev at lists.llvm.org Subject: [llvm-dev] Documentation cleanup review process? Dear llvm-dev, As I've been working with llvm sources on a prototype backend, it seems to me that much of the documentation on llvm internals is, shall we say, wanting. (I'm looking at you particularly, tablegen.) I can clean up documentation issues and clarify in the .rst files as I'm learning, but the code submission process is silent on how documentation changes make it into master. At this point, even CODE_OWNERS.TXT is silent on who is responsible for the doc directory. Pointers would be helpful. Thank you very much. -- --- John Byrd Gigantic Software 2321 E 4th Street Suite C #429 Santa Ana, CA 92705-3862 http://www.giganticsoftware.com T: (949) 892-3526 F: (206) 309-0850 -------------- next part -------------- An HTML attachment was scrubbed... URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20190613/e8df44ea/attachment.html>
James Henderson via llvm-dev
2019-Jun-18 09:49 UTC
[llvm-dev] Documentation cleanup review process?
I've been following the standard review and commit process for documentation updates for a number of issues recently (see for example https://reviews.llvm.org/D63275). Ultimately, take a look at who has recently updated the relevant area of the doc and/or the tool/feature itself. James On Thu, 13 Jun 2019 at 20:43, Sjoerd Meijer via llvm-dev < llvm-dev at lists.llvm.org> wrote:> I don't think documentation works much different than source-code. I.e., > patches welcome, and you can always upload a diff for e.g. any of the .rst > files in the doc directory. Usually good candidates for reviewers are > people who last touched the same piece of code/text, which you can find out > with a git/svn blame. > > Cheers, > Sjoerd. > ------------------------------ > *From:* llvm-dev <llvm-dev-bounces at lists.llvm.org> on behalf of John Byrd > via llvm-dev <llvm-dev at lists.llvm.org> > *Sent:* 13 June 2019 20:20 > *To:* llvm-dev at lists.llvm.org > *Subject:* [llvm-dev] Documentation cleanup review process? > > Dear llvm-dev, > > As I've been working with llvm sources on a prototype backend, it seems to > me that much of the documentation on llvm internals is, shall we say, > wanting. (I'm looking at you particularly, tablegen.) > > I can clean up documentation issues and clarify in the .rst files as I'm > learning, but the code submission process is silent on how documentation > changes make it into master. At this point, even CODE_OWNERS.TXT is silent > on who is responsible for the doc directory. > > Pointers would be helpful. Thank you very much. > -- > --- > > John Byrd > Gigantic Software > 2321 E 4th Street > Suite C #429 > Santa Ana, CA 92705-3862 > http://www.giganticsoftware.com > T: (949) 892-3526 F: (206) 309-0850 > _______________________________________________ > LLVM Developers mailing list > llvm-dev at lists.llvm.org > https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev >-------------- next part -------------- An HTML attachment was scrubbed... URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20190618/d2b58b0c/attachment.html>