llvm dev - Jun 2014 - [LLVMdev] [LLVM Doc] tblgen backends

I agree, but I have no experience with LLVM doc.
The job is very simple: add link at page
https://github.com/draperlaboratory/fracture/wiki/How-TableGen%27s-DAGISel-Backend-Works
into doc page
http://llvm.org/docs/TableGen/BackEnds.html
But how I can do it?


On Tue, Jun 3, 2014 at 4:41 PM, Renato Golin <renato.golin at linaro.org>
wrote:
> Hi Daniil,
>
> Those look great! I think it could be factored into the current docs,
> so as to not duplicate the same information in other places, and I'd
> love to see it in.
>
> Are you volunteering for the job? :)
>
> cheers,
> --renato
>
> On 3 June 2014 13:33, Daniil Troshkov <troshkovdanil at gmail.com>
wrote:
> > Hi all!
> >
> > There is doc about tglben backends:
> >
> > http://llvm.org/docs/TableGen/BackEnds.html
> >
> > May be should to add link at
> >
> >
>
https://github.com/draperlaboratory/fracture/wiki/How-TableGen%27s-DAGISel-Backend-Works
> >
> > I remember when I first met the LLVM it would be very useful.
> >
> > _______________________________________________
> > LLVM Developers mailing list
> > LLVMdev at cs.uiuc.edu         http://llvm.cs.uiuc.edu
> > http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
> >
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://lists.llvm.org/pipermail/llvm-dev/attachments/20140603/a93cd4a0/attachment.html>

On 3 June 2014 14:10, Daniil Troshkov <troshkovdanil at gmail.com>
wrote:
> The job is very simple: add link at page
>
https://github.com/draperlaboratory/fracture/wiki/How-TableGen%27s-DAGISel-Backend-Works
> into doc page
> http://llvm.org/docs/TableGen/BackEnds.html
That's not what I meant. There are some parts of that doc that are
redundant with what we have already on http://llvm.org/docs/TableGen/,
so just adding a link wouldn't help people that are reading them make
any sense of why we should redirect them to another, different but
slightly similar, doc.

What I meant was to add the *contents* of that doc (with the author's
permission) into our docs, by merging the contents and removing the
duplication.

About LLVM's docs, it's based on Sphinx (http://sphinx-doc.org/ or
http://lld.llvm.org/sphinx_intro.html) and this
(http://llvm.org/docs/SphinxQuickstartTemplate.html) should get you
going with LLVM docs. At the end, just submit your patch to the
llvm-commits list and if approved, it'll be merged.

cheers,
--renato

On Tue, Jun 3, 2014 at 7:30 AM, Renato Golin <renato.golin at linaro.org>
wrote:
> On 3 June 2014 14:10, Daniil Troshkov <troshkovdanil at gmail.com>
wrote:
> > The job is very simple: add link at page
> >
>
https://github.com/draperlaboratory/fracture/wiki/How-TableGen%27s-DAGISel-Backend-Works
> > into doc page
> > http://llvm.org/docs/TableGen/BackEnds.html
>
> That's not what I meant. There are some parts of that doc that are
> redundant with what we have already on http://llvm.org/docs/TableGen/,
> so just adding a link wouldn't help people that are reading them make
> any sense of why we should redirect them to another, different but
> slightly similar, doc.
>
> What I meant was to add the *contents* of that doc (with the author's
> permission) into our docs, by merging the contents and removing the
> duplication.
>
That would be nice but that is a lot more effort, so much so that I would
consider it a separate effort to do so. For now I think that providing a
link under http://llvm.org/docs/TableGen/BackEnds.html#dagisel is a simple
way to connect developers looking for information with useful information.

-- Sean Silva

>
> About LLVM's docs, it's based on Sphinx (http://sphinx-doc.org/ or
> http://lld.llvm.org/sphinx_intro.html) and this
> (http://llvm.org/docs/SphinxQuickstartTemplate.html) should get you
> going with LLVM docs. At the end, just submit your patch to the
> llvm-commits list and if approved, it'll be merged.
>
> cheers,
> --renato
> _______________________________________________
> LLVM Developers mailing list
> LLVMdev at cs.uiuc.edu         http://llvm.cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://lists.llvm.org/pipermail/llvm-dev/attachments/20140606/735e52c9/attachment.html>

On Tue, Jun 3, 2014 at 7:10 AM, Daniil Troshkov <troshkovdanil at
gmail.com>
wrote:
> I agree, but I have no experience with LLVM doc.
> The job is very simple: add link at page
>
>
https://github.com/draperlaboratory/fracture/wiki/How-TableGen%27s-DAGISel-Backend-Works
> into doc page
> http://llvm.org/docs/TableGen/BackEnds.html
> But how I can do it?
>
As always, send a patch to llvm-commits (and feel free to CC me on it). See
docs/README.txt for how the content on llvm.org/docs relates to the docs/
directory.

-- Sean Silva

>
>
> On Tue, Jun 3, 2014 at 4:41 PM, Renato Golin <renato.golin at
linaro.org>
> wrote:
>
>> Hi Daniil,
>>
>> Those look great! I think it could be factored into the current docs,
>> so as to not duplicate the same information in other places, and
I'd
>> love to see it in.
>>
>> Are you volunteering for the job? :)
>>
>> cheers,
>> --renato
>>
>> On 3 June 2014 13:33, Daniil Troshkov <troshkovdanil at
gmail.com> wrote:
>> > Hi all!
>> >
>> > There is doc about tglben backends:
>> >
>> > http://llvm.org/docs/TableGen/BackEnds.html
>> >
>> > May be should to add link at
>> >
>> >
>>
https://github.com/draperlaboratory/fracture/wiki/How-TableGen%27s-DAGISel-Backend-Works
>> >
>> > I remember when I first met the LLVM it would be very useful.
>> >
>> > _______________________________________________
>> > LLVM Developers mailing list
>> > LLVMdev at cs.uiuc.edu         http://llvm.cs.uiuc.edu
>> > http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
>> >
>>
>
>
> _______________________________________________
> LLVM Developers mailing list
> LLVMdev at cs.uiuc.edu         http://llvm.cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://lists.llvm.org/pipermail/llvm-dev/attachments/20140606/94eaa6b4/attachment.html>