diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index 8fc1712c..1d4e5ee2 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -1649,6 +1649,8 @@ outputs: type: 'kiri' dir: 'Example/kiri_dir' options: + # [string='#FFFFFF'] Color used for the background of the diff canvas + background_color: '#FFFFFF' # [string='_builtin_classic'] Selects the color theme. Only applies to KiCad 6. # To use the KiCad 6 default colors select `_builtin_default`. # Usually user colors are stored as `user`, but you can give it another name @@ -1658,11 +1660,14 @@ outputs: dnf_filter: '_none' # [boolean=false] Avoid PCB and SCH images regeneration. Useful for incremental usage keep_generated: false - # [string='%f-%i%I%v.%x'] Filename for the output (%i=diff_pcb/diff_sch, %x=pdf). Affected by global options - output: '%f-%i%I%v.%x' + # [number=0] Maximum number of commits to include. Use 0 for all available commits + max_commits: 0 # [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. # A short-cut to use for simple cases where a variant is an overkill pre_transform: '_none' + # [string='HEAD'] Starting point for the commits, can be a branch, a hash, etc. + # Note that this can be a revision-range, consult the gitrevisions manual for more information + revision: 'HEAD' # [string=''] Board variant to apply variant: '' layers: all diff --git a/docs/source/configuration/outputs/kiri.rst b/docs/source/configuration/outputs/kiri.rst index 752b2ad0..8c492e63 100644 --- a/docs/source/configuration/outputs/kiri.rst +++ b/docs/source/configuration/outputs/kiri.rst @@ -40,13 +40,16 @@ Parameters: To use the KiCad 6 default colors select `_builtin_default`. Usually user colors are stored as `user`, but you can give it another name. - **keep_generated** :index:`: ` [boolean=false] Avoid PCB and SCH images regeneration. Useful for incremental usage. - - **output** :index:`: ` [string='%f-%i%I%v.%x'] Filename for the output (%i=diff_pcb/diff_sch, %x=pdf). Affected by global options. + - ``background_color`` :index:`: ` [string='#FFFFFF'] Color used for the background of the diff canvas. - ``dnf_filter`` :index:`: ` [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill. + - ``max_commits`` :index:`: ` [number=0] Maximum number of commits to include. Use 0 for all available commits. - ``pre_transform`` :index:`: ` [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill. + - ``revision`` :index:`: ` [string='HEAD'] Starting point for the commits, can be a branch, a hash, etc. + Note that this can be a revision-range, consult the gitrevisions manual for more information. - ``variant`` :index:`: ` [string=''] Board variant to apply. - **type** :index:`: ` [string=''] Type of output.