[DOC] begin documentation of environment variables
Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
		
					parent
					
						
							
								8448628461
							
						
					
				
			
			
				commit
				
					
						5d62370ff1
					
				
			
		
					 3 changed files with 15 additions and 13 deletions
				
			
		|  | @ -1,5 +1,6 @@ | |||
| Documentation cleanup | ||||
|    - to_check/cdist-type.text | ||||
|    - document environment variables | ||||
|    - cdist-type-integration | ||||
|       - Ensure available types are documented (!)  | ||||
|          - define how to in cdist-type-integration | ||||
|  |  | |||
|  | @ -38,12 +38,6 @@ Documentation: | |||
|       - via version control | ||||
|    - Define how to raise errors in types | ||||
| 
 | ||||
|    - = todo | ||||
|    + = in progress -> S|N | ||||
|    x = done | ||||
| 
 | ||||
| 
 | ||||
|    x remove old documentation from doc/man/! | ||||
|    - Check all references in manpages, ensure all manpages exist, generic ones: | ||||
|       + cdist | ||||
|          + cdist-deploy-to | ||||
|  | @ -53,13 +47,6 @@ Documentation: | |||
|             - install packages only if not existent | ||||
|             - copy file only if different | ||||
|          - DOC document that $type/manifest is executed for every object/instance | ||||
|       - exported variables: | ||||
|          - general explorer: __explorer                           # cdist-explorer | ||||
|          - initial manifest: __manifest, __global                 # cdist-manifest | ||||
|          - type manifests  __object, __object_id, __global        # cdist-type | ||||
|          - type explorers:  __object, __object_id, __type_explorers # cdist-type | ||||
|          - type codegen:  __object, __object_id, __global         # cdist-type | ||||
|          - type code:  -                                          # cdist-code | ||||
|    - category 7: | ||||
|       - cdist-manifest(7) | ||||
|       - cdist-explorer | ||||
|  |  | |||
							
								
								
									
										14
									
								
								doc/man/to_check/cdist-environment-variables.text
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										14
									
								
								doc/man/to_check/cdist-environment-variables.text
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,14 @@ | |||
| Update on env: | ||||
| 
 | ||||
|    general explorer: __explorer | ||||
|    initial manifest: __manifest, __global | ||||
|    type manifests  __object, __object_id, __global | ||||
|    type explorers:  __object, __object_id, __type_explorers, __global | ||||
|    type codegen:  __object, __object_id, __global | ||||
|    type code:  - | ||||
| 
 | ||||
| 
 | ||||
| - __object: Path to the object that we are working on | ||||
| - __object_id: type unique object id | ||||
| - __global: contains global information (see cdist-env | ||||
| 
 | ||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue