document files/ directories (in object and type)
Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
		
					parent
					
						
							
								adbf670309
							
						
					
				
			
			
				commit
				
					
						27286c787d
					
				
			
		
					 1 changed files with 8 additions and 0 deletions
				
			
		| 
						 | 
					@ -179,6 +179,14 @@ level tools like ruby installed. If a type requires specific tools to be present
 | 
				
			||||||
on the target, there must be another type that provides this tool and the first
 | 
					on the target, there must be another type that provides this tool and the first
 | 
				
			||||||
type should create an object of the specific type.
 | 
					type should create an object of the specific type.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					If your type wants to save temporay data, that may be used by other types
 | 
				
			||||||
 | 
					later on (for instance __file), you can save them in the subdirectory
 | 
				
			||||||
 | 
					"files" below $__object (but you must create it yourself). cdist will not touch
 | 
				
			||||||
 | 
					this directory.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					If your type contains static files, it's also recommened to place them in
 | 
				
			||||||
 | 
					a folder named "files" within the type (again, because cdist guarantees to
 | 
				
			||||||
 | 
					never ever touch this folder).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
HOW TO INCLUDE A TYPE INTO UPSTREAM CDIST
 | 
					HOW TO INCLUDE A TYPE INTO UPSTREAM CDIST
 | 
				
			||||||
-----------------------------------------
 | 
					-----------------------------------------
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue