[PATCH] D105798: [docs]Examples to show implementation of GISel in AArch64

[Jessica Paquette via Phabricator via llvm-commits]

paquette added a comment.

I think that including entire code snippets will probably rot over time and potentially confuse readers.

I think in general, it would be good to focus on high-level concepts so that we don't need to do as much work keeping this in sync with the code.

Also, I'm not sure if we have documentation on terminology like "incoming arguments". If we do, I think it would be useful to link to the documentation for the terminology.



================
Comment at: llvm/docs/GlobalISel/AArch64examples.rst:2
+===============================
+GISel Implementation In AArch64 
+===============================
----------------
Maybe more concise?


================
Comment at: llvm/docs/GlobalISel/AArch64examples.rst:12
+
+Illustrating with examples to show the implementation of GlobalISel in AArch64.
+
----------------
Can you expand on this a little?

- What kinds of examples does this documentation contain?
- What can the reader expect to find in this documentation?


================
Comment at: llvm/docs/GlobalISel/AArch64examples.rst:22
+To lower incoming arguments.
+.. code-block:: none
+   bool AArch64CallLowering::lowerFormalArguments(
----------------
I think that this code sample may rot over time. I think it would be better to describe, at a high level

- What lowering incoming arguments means
- What must be done to lower incoming arguments

And then say "see `AArch64CallLowering::lowerFormalArguments`" for a sample.


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D105798