[PATCH] D100714: [docs] Add a new tutorial that talk about how to make a change to llvm.

[ZhiqianXia via Phabricator via llvm-commits]

xzq0528 added a comment.

In D100714#2759101 <https://reviews.llvm.org/D100714#2759101>, @xgupta wrote:

> In D100714#2698201 <https://reviews.llvm.org/D100714#2698201>, @kuhnel wrote:
>
>> 
>
>
>
>> I guess we should also link to this tutorial from the getting involved page <https://llvm.org/docs/GettingInvolved.html>, what do you think?
>
> @xzq0528 I think you need to address this comment in this patch. because of it following warning/error is generating during build
>
>   Warning, treated as error:
>   /home/xgupta/llvm-project/llvm/docs/MyFirstTypoFix.rst:document isn't included in any toctree
>   make[3]: *** [docs/CMakeFiles/docs-llvm-html.dir/build.make:77: docs/CMakeFiles/docs-llvm-html] Error 2
>   make[2]: *** [CMakeFiles/Makefile2:244554: docs/CMakeFiles/docs-llvm-html.dir/all] Error 2
>   make[1]: *** [CMakeFiles/Makefile2:244561: docs/CMakeFiles/docs-llvm-html.dir/rule] Error 2
>   make: *** [Makefile:47070: docs-llvm-html] Error 2```.
>   
>    I will check it as soon as possible.





================
Comment at: llvm/docs/MyFirstTypoFix.rst:2
+.. contents::
+.. _header-n3766:
+
----------------
gribozavr2 wrote:
> I'd suggest removing automatically numbered header-ABCD links, I don't think other documents do this. Sphinx will generate a link based on the section title.
i'll remove it later. Thank you.


================
Comment at: llvm/docs/MyFirstTypoFix.rst:324
+   $ git checkout -b myfirstpatch
+   $ git commit -am "[Docs] Clarify -Winfinite-recursion message"
+
----------------
xgupta wrote:
> @xzq0528 Actually, here a [Diagnostic] tag would be appropriate, instead of [Docs] one.
@xgupta thank you for pointing out the issue. 


================
Comment at: llvm/docs/MyFirstTypoFix.rst:437
+Review expectations
+-------------------
+
----------------
mehdi_amini wrote:
> Seems like some other docs should be linked from this docs in the relevant sections, I don't see a ref to https://llvm.org/docs/CodeReview.html or https://llvm.org/docs/CodeReview.html for example.
> 
> ( But also below in the revert section which like could link https://llvm.org/docs/DeveloperPolicy.html#patch-reversion-policy )
Thanks for your helpful sugeestions, I'll add it later.


================
Comment at: llvm/docs/MyFirstTypoFix.rst:480
+
+LLVM uses Subversion, rather than Git, for committing changes. (Yes,
+it's confusing!)You will need a Subversion username and password. It's
----------------
nikic wrote:
> This looks outdated?
Thanks for point out the issue.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D100714/new/

https://reviews.llvm.org/D100714