diff options
| author | DeForest Richards <d4m1887@gmail.com> | 2019-09-05 17:30:52 +0000 |
|---|---|---|
| committer | DeForest Richards <d4m1887@gmail.com> | 2019-09-05 17:30:52 +0000 |
| commit | e3e6624ca2d0e2cc31793aa36dd07c35683a2f14 (patch) | |
| tree | e9a794ebdcfb64ff1ca2a6dd4a930feeec09ff20 /llvm/docs/ProgrammingDocumentation.rst | |
| parent | 10412a69f93ec3b88a65923bb9366e1225107b31 (diff) | |
| download | bcm5719-llvm-e3e6624ca2d0e2cc31793aa36dd07c35683a2f14.tar.gz bcm5719-llvm-e3e6624ca2d0e2cc31793aa36dd07c35683a2f14.zip | |
Docs: Move Documentation sections to separate pages.
Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project.
llvm-svn: 371096
Diffstat (limited to 'llvm/docs/ProgrammingDocumentation.rst')
| -rw-r--r-- | llvm/docs/ProgrammingDocumentation.rst | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/llvm/docs/ProgrammingDocumentation.rst b/llvm/docs/ProgrammingDocumentation.rst new file mode 100644 index 00000000000..a5115089853 --- /dev/null +++ b/llvm/docs/ProgrammingDocumentation.rst @@ -0,0 +1,75 @@ +Programming Documentation
+=========================
+
+For developers of applications which use LLVM as a library.
+
+.. toctree::
+ :hidden:
+
+ Atomics
+ CodingStandards
+ CommandLine
+ CompilerWriterInfo
+ ExtendingLLVM
+ HowToSetUpLLVMStyleRTTI
+ ProgrammersManual
+ Extensions
+ LibFuzzer
+ FuzzingLLVM
+ ScudoHardenedAllocator
+ OptBisect
+ GwpAsan
+
+:doc:`LLVM Language Reference Manual <LangRef>`
+ Defines the LLVM intermediate representation and the assembly form of the
+ different nodes.
+
+:doc:`Atomics`
+ Information about LLVM's concurrency model.
+
+:doc:`ProgrammersManual`
+ Introduction to the general layout of the LLVM sourcebase, important classes
+ and APIs, and some tips & tricks.
+
+:doc:`Extensions`
+ LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
+
+:doc:`CommandLine`
+ Provides information on using the command line parsing library.
+
+:doc:`CodingStandards`
+ Details the LLVM coding standards and provides useful information on writing
+ efficient C++ code.
+
+:doc:`HowToSetUpLLVMStyleRTTI`
+ How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
+ class hierarchy.
+
+:doc:`ExtendingLLVM`
+ Look here to see how to add instructions and intrinsics to LLVM.
+
+`Doxygen generated documentation <http://llvm.org/doxygen/>`_
+ (`classes <http://llvm.org/doxygen/inherits.html>`_)
+
+`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
+
+`Github Source Repository Browser <http://github.com/llvm/llvm-project//>`_
+ ..
+
+:doc:`CompilerWriterInfo`
+ A list of helpful links for compiler writers.
+
+:doc:`LibFuzzer`
+ A library for writing in-process guided fuzzers.
+
+:doc:`FuzzingLLVM`
+ Information on writing and using Fuzzers to find bugs in LLVM.
+
+:doc:`ScudoHardenedAllocator`
+ A library that implements a security-hardened `malloc()`.
+
+:doc:`OptBisect`
+ A command line option for debugging optimization-induced failures.
+
+:doc:`GwpAsan`
+ A sampled heap memory error detection toolkit designed for production use.
\ No newline at end of file |
