Paul C. Anagnostopoulos via llvm-dev
2020-Aug-05 01:13 UTC
[llvm-dev] TableGen trace facility
I wasn't sure how to respond to John Byrd's post, since it wasn't addressed to me. So I've responded to Nicolai's. I'm reasonably far along in the process of writing a new Programmer's Guide for TableGen. I will continue working on it and submit it for review. I expect to do some rewriting as a result. John: Would you like me to respect a copyright on your documents linked below? I wouldn't take any text verbatim, but some of the ways of describing TableGen give me ideas. ---------------------------------------- Similarly, I've just survived writing most of a new backend, and TableGen's documentation was unfortunate. Chris's old original documentation was incomplete, but it was clear, and as such the original sketches were superior to the current state of TableGen documentation. TableGen needs a proper programmer's guide, which differs from a reference. I actually started such a rewrite here, but I never tried submitting it to Phabricator, because it wasn't clear to me who was responsible for review: https://github.com/johnwbyrd/llvm-mos/blob/master/llvm/docs/TableGen/index.rst https://github.com/johnwbyrd/llvm-mos/blob/master/llvm/docs/TableGen/Deficiencies.rst Most of the concepts behind TableGen are simple. They should be communicated simply, as per Chris's original documentation. The things that are not simple, were developed as special-purpose solutions to practical problems. The current documentation should be rewritten almost entirely from scratch, with a strong focus on organizing the document in a reasonable reading order, with a target audience of those who are working on LLVM backends. Patching the documentation has gotten it to its current state of confusion, and the process should be discontinued. Likewise, I'll mention that if anyone wants to finance authorship of proper TableGen and/or backend documentation, I'd be game to research it and write it. --- John Byrd
> I wasn't sure how to respond to John Byrd's post, since it wasn'taddressed to me. So I've responded to Nicolai's. It was intended for you and the others on the thread.> I'm reasonably far along in the process of writing a new Programmer'sGuide for TableGen. I will continue working on it and submit it for review. I expect to do some rewriting as a result. I'd like to collaborate, if you point me at your tree. Like you, I also have both a strong need for the documentation, and some strong opinions on how it might be improved.> John: Would you like me to respect a copyright on your documents linkedbelow? I wouldn't take any text verbatim, but some of the ways of describing TableGen give me ideas. Not a bit -- I had intended to submit it as a patch, but got sidetracked. Use it however you can -- jwb -------------- next part -------------- An HTML attachment was scrubbed... URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20200805/9abc9394/attachment.html>
Paul C. Anagnostopoulos via llvm-dev
2020-Aug-05 18:38 UTC
[llvm-dev] TableGen trace facility
Thanks for the open invitation to use your text. I am writing the Programmer's Guide as a .rst file, as you'd expect. It's just sitting in a working directory alongside my copy of the repository. I'm not sure what you mean by pointing to my tree, but I presume you're talking about reviewing it prior to submitting it for review with Phabricator? (Forgive my newbieness.) At 8/5/2020 02:16 PM, John Byrd wrote:>> I wasn't sure how to respond to John Byrd's post, since it wasn't addressed to me. So I've responded to Nicolai's. > >It was intended for you and the others on the thread. > >> I'm reasonably far along in the process of writing a new Programmer's Guide for TableGen. I will continue working on it and submit it for review. I expect to do some rewriting as a result. > >I'd like to collaborate, if you point me at your tree. Like you, I also have both a strong need for the documentation, and some strong opinions on how it might be improved. > >> John: Would you like me to respect a copyright on your documents linked below? I wouldn't take any text verbatim, but some of the ways of describing TableGen give me ideas. > >Not a bit -- I had intended to submit it as a patch, but got sidetracked. Use it however you can -- > >jwb
Paul C. Anagnostopoulos via llvm-dev
2020-Aug-05 20:43 UTC
[llvm-dev] Combine TableGen documents?
Thanks for the open invitation to use your text. I am writing the Programmer's Guide as a .rst file, as you'd expect. It's just sitting in a working directory alongside my copy of the repository. I'm not sure what you mean by pointing to my tree, but I presume you're talking about reviewing it prior to submitting it for review with Phabricator? (Forgive my newbieness.) At 8/5/2020 02:16 PM, John Byrd wrote:>> I wasn't sure how to respond to John Byrd's post, since it wasn't addressed to me. So I've responded to Nicolai's. > >It was intended for you and the others on the thread. > >> I'm reasonably far along in the process of writing a new Programmer's Guide for TableGen. I will continue working on it and submit it for review. I expect to do some rewriting as a result. > >I'd like to collaborate, if you point me at your tree. Like you, I also have both a strong need for the documentation, and some strong opinions on how it might be improved. > >> John: Would you like me to respect a copyright on your documents linked below? I wouldn't take any text verbatim, but some of the ways of describing TableGen give me ideas. > >Not a bit -- I had intended to submit it as a patch, but got sidetracked. Use it however you can -- > >jwb---------------------------------------------------------------- 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
Paul C. Anagnostopoulos via llvm-dev
2020-Aug-09 15:06 UTC
[llvm-dev] TableGen trace facility
John, I'm pretty much down to details and smoothing the text. Here is a pdf. Can you mark it with comments? Or you can send an email with a list. I will incorporate your comments and send you a second proof, so you can be sure I understood you. Is a week long enough? ~~ Paul At 8/5/2020 02:16 PM, John Byrd wrote:>I'd like to collaborate, if you point me at your tree. Like you, I also have both a strong need for the documentation, and some strong opinions on how it might be improved.-------------- next part -------------- A non-text attachment was scrubbed... Name: TableGen-Programmers-Guide.pdf Type: application/pdf Size: 462329 bytes Desc: not available URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20200809/9ae9f3af/attachment-0001.pdf> -------------- next part -------------- ---------------------------------------------------------------- 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