Paul C. Anagnostopoulos via llvm-dev
2020-Jul-27 00:34 UTC
[llvm-dev] Documentation corrections
Folks, I am interested in contributing to LLVM in the future. Meanwhile, I am reading many of the project documents (right now, "TableGen Language Reference"). Is there a way I can contribute corrections to these documents without cloning and building LLVM? ~~ Paul ---------------------------------------------------------------- Windfall Paul C. Anagnostopoulos ---------------------------------------------------------- Software 978 369-0839 www.windfall.com ---------------------------------------------------------------- My life has been filled with calamities, some of which actually happened. ---Mark Twain Guga 'mzimba, sala 'nhliziyo
Hi, Yeah, you can. You could submit a patch without even downloading it I think, but let's say you do. Then you just edit e.g. this file: https://github.com/llvm/llvm-project/blob/master/llvm/docs/TableGen/LangRef.rst So basically, .rst files under /llvm/docs (You'll understand the format easily but you can also ask or/amd search for sphinx doc) And finally you submit a patch as described here: https://llvm.org/docs/Phabricator.html Let us know if you have any problems. Best, Stefanos -- Sent over my phone, format is maybe not the best On Mon, Jul 27, 2020, 03:34 Paul C. Anagnostopoulos via llvm-dev < llvm-dev at lists.llvm.org> wrote:> Folks, > > I am interested in contributing to LLVM in the future. Meanwhile, I am > reading many of the project documents (right now, "TableGen Language > Reference"). Is there a way I can contribute corrections to these documents > without cloning and building LLVM? > > ~~ Paul > > ---------------------------------------------------------------- > Windfall Paul C. Anagnostopoulos > ---------------------------------------------------------- > Software 978 369-0839 > www.windfall.com > ---------------------------------------------------------------- > My life has been filled with calamities, > some of which actually happened. > ---Mark Twain > > Guga 'mzimba, sala 'nhliziyo > > _______________________________________________ > 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/20200727/fa963880/attachment.html>
In addition to what Stefanos said: a) Please. That would be wonderful. b) Feel free to add me as a reviewer. -eric On Sun, Jul 26, 2020 at 5:57 PM Stefanos Baziotis via llvm-dev < llvm-dev at lists.llvm.org> wrote:> Hi, > > Yeah, you can. You could submit > a patch without even downloading it > I think, but let's say you do. > > Then you just edit e.g. this file: > https://github.com/llvm/llvm-project/blob/master/llvm/docs/TableGen/LangRef.rst > > So basically, .rst files under /llvm/docs (You'll understand the format > easily but you can also ask or/amd search for sphinx doc) > > And finally you submit a patch as described here: > https://llvm.org/docs/Phabricator.html > > Let us know if you have any problems. > > Best, > Stefanos > > -- Sent over my phone, format is maybe not the best > > On Mon, Jul 27, 2020, 03:34 Paul C. Anagnostopoulos via llvm-dev < > llvm-dev at lists.llvm.org> wrote: > >> Folks, >> >> I am interested in contributing to LLVM in the future. Meanwhile, I am >> reading many of the project documents (right now, "TableGen Language >> Reference"). Is there a way I can contribute corrections to these documents >> without cloning and building LLVM? >> >> ~~ Paul >> >> ---------------------------------------------------------------- >> Windfall Paul C. Anagnostopoulos >> ---------------------------------------------------------- >> Software 978 369-0839 >> www.windfall.com >> ---------------------------------------------------------------- >> My life has been filled with calamities, >> some of which actually happened. >> ---Mark Twain >> >> Guga 'mzimba, sala 'nhliziyo >> >> _______________________________________________ >> LLVM Developers mailing list >> llvm-dev at lists.llvm.org >> https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev >> > _______________________________________________ > 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/20200726/3ab30c2e/attachment.html>