docs: Extended "layers" section in the user guide.
Adding `.` was not intuitively for me, therefore an explicit comment on how to add both the repo and a subdir might be useful. Signed-off-by: Tobias Schmidl <tobias@schmidl.dev> Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
This commit is contained in:
		
				
					committed by
					
						
						Jan Kiszka
					
				
			
			
				
	
			
			
			
						parent
						
							e3af001f53
						
					
				
				
					commit
					6044d85fb8
				
			@@ -392,6 +392,22 @@ Configuration reference
 | 
				
			|||||||
        Contains the layers from this repository that should be added to the
 | 
					        Contains the layers from this repository that should be added to the
 | 
				
			||||||
        ``bblayers.conf``. If this is missing or ``None`` or and empty
 | 
					        ``bblayers.conf``. If this is missing or ``None`` or and empty
 | 
				
			||||||
        dictionary, the path to the repo itself is added as a layer.
 | 
					        dictionary, the path to the repo itself is added as a layer.
 | 
				
			||||||
 | 
					        Additionally, ``.`` is a valid value if the repo itself should be added
 | 
				
			||||||
 | 
					        as a layer. This allows combinations:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					        .. code-block:: yaml
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					            repos:
 | 
				
			||||||
 | 
					              meta-foo:
 | 
				
			||||||
 | 
					                url: https://github.com/bar/meta-foo.git
 | 
				
			||||||
 | 
					                path: layers/meta-foo
 | 
				
			||||||
 | 
					                refspec: master
 | 
				
			||||||
 | 
					                layers:
 | 
				
			||||||
 | 
					                  .:
 | 
				
			||||||
 | 
					                  contrib:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					        This adds both ``layers/meta-foo`` and ``layers/meta-foo/contrib`` from
 | 
				
			||||||
 | 
					        the ``meta-foo`` repository to ``bblayers.conf``.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
      * ``<layer-path>``: enum [optional]
 | 
					      * ``<layer-path>``: enum [optional]
 | 
				
			||||||
          Adds the layer with ``<layer-path>`` that is relative to the
 | 
					          Adds the layer with ``<layer-path>`` that is relative to the
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user