| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 1 | .. _development_process: |
| 2 | |
| 3 | Development Process Documentation |
| 4 | ================================= |
| 5 | |
| Bill Wendling | 9e22640 | 2012-06-19 22:25:41 +0000 | [diff] [blame] | 6 | .. toctree:: |
| 7 | :hidden: |
| 8 | |
| Bill Wendling | 2c8293d | 2012-06-20 02:57:56 +0000 | [diff] [blame] | 9 | CodingStandards |
| Bill Wendling | 9059390 | 2012-06-20 04:20:39 +0000 | [diff] [blame] | 10 | MakefileGuide |
| 11 | Projects |
| Bill Wendling | 9e22640 | 2012-06-19 22:25:41 +0000 | [diff] [blame] | 12 | |
| Bill Wendling | 6062958 | 2012-06-20 11:53:08 +0000 | [diff] [blame^] | 13 | * :ref:`projects` |
| Bill Wendling | 9e22640 | 2012-06-19 22:25:41 +0000 | [diff] [blame] | 14 | |
| Bill Wendling | 6062958 | 2012-06-20 11:53:08 +0000 | [diff] [blame^] | 15 | How-to guide and templates for new projects that *use* the LLVM |
| 16 | infrastructure. The templates (directory organization, Makefiles, and test |
| 17 | tree) allow the project code to be located outside (or inside) the ``llvm/`` |
| 18 | tree, while using LLVM header files and libraries. |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 19 | |
| Bill Wendling | 6062958 | 2012-06-20 11:53:08 +0000 | [diff] [blame^] | 20 | * :ref:`coding_standards` |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 21 | |
| Bill Wendling | 6062958 | 2012-06-20 11:53:08 +0000 | [diff] [blame^] | 22 | Describes a few coding standards that are used in the LLVM source tree. All |
| 23 | code submissions must follow the coding standards before being allowed into |
| 24 | the source tree. |
| Bill Wendling | 2c8293d | 2012-06-20 02:57:56 +0000 | [diff] [blame] | 25 | |
| Bill Wendling | 6062958 | 2012-06-20 11:53:08 +0000 | [diff] [blame^] | 26 | * `LLVMBuild Documentation <LLVMBuild.html>`_ |
| Bill Wendling | 2c8293d | 2012-06-20 02:57:56 +0000 | [diff] [blame] | 27 | |
| Bill Wendling | 6062958 | 2012-06-20 11:53:08 +0000 | [diff] [blame^] | 28 | Describes the LLVMBuild organization and files used by LLVM to specify |
| 29 | component descriptions. |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 30 | |
| Bill Wendling | 6062958 | 2012-06-20 11:53:08 +0000 | [diff] [blame^] | 31 | * :ref:`makefile_guide` |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 32 | |
| Bill Wendling | 6062958 | 2012-06-20 11:53:08 +0000 | [diff] [blame^] | 33 | Describes how the LLVM makefiles work and how to use them. |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 34 | |
| Bill Wendling | 6062958 | 2012-06-20 11:53:08 +0000 | [diff] [blame^] | 35 | * `How To Release LLVM To The Public <HowToReleaseLLVM.html>`_ |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 36 | |
| Bill Wendling | 6062958 | 2012-06-20 11:53:08 +0000 | [diff] [blame^] | 37 | This is a guide to preparing LLVM releases. Most developers can ignore it. |