From 13d2e43c15eb979d6ada386e5954a3753b714f54 Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Mon, 25 Oct 2021 13:57:59 -0300 Subject: [PATCH] Updated docs (sort_style) --- README.md | 1 + docs/samples/generic_plot.kibot.yaml | 2 ++ 2 files changed, 3 insertions(+) diff --git a/README.md b/README.md index b17ceb6c..c7e48e25 100644 --- a/README.md +++ b/README.md @@ -728,6 +728,7 @@ Next time you need this list just use an alias, like this: - `output`: [string='%f-%i%v.%x'] filename for the output (%i=bom). Affected by global options. - `ref_id`: [string=''] A prefix to add to all the references from this project. Used for multiple projects. - `ref_separator`: [string=' '] Separator used for the list of references. + - `sort_style`: [string='type_value'] [type_value,type_value_ref,ref] Sorting criteria. - `source_by_id`: [boolean=false] Generate the `Source BoM` column using the reference ID instead of the project name. - `use_alt`: [boolean=false] Print grouped references in the alternate compressed style eg: R1-R7,R18. - `variant`: [string=''] Board variant, used to determine which components diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index 9ed2d65d..dea7d583 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -185,6 +185,8 @@ outputs: ref_id: '' # [string=' '] Separator used for the list of references ref_separator: ' ' + # [string='type_value'] [type_value,type_value_ref,ref] Sorting criteria + sort_style: 'type_value' # [boolean=false] Generate the `Source BoM` column using the reference ID instead of the project name source_by_id: false # [boolean=false] Print grouped references in the alternate compressed style eg: R1-R7,R18