Skip to content

CFE-4372: Clarified --masterfiles argument's manual #240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
olehermanse merged 1 commit into from
Jul 1, 2025
Merged

CFE-4372: Clarified --masterfiles argument's manual #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion cfbs/args.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ def get_arg_parser():
action="store_true",
)
parser.add_argument(
"--masterfiles", help="Add masterfiles on cfbs init choose between"
"--masterfiles",
help='Specify masterfiles version to add during "cfbs init". This can be a branch, a full version number, or `no` to not add masterfiles at all.',
)
return parser
12 changes: 7 additions & 5 deletions cfbs/cfbs.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH CFBS "1" "2025\-04\-03" "cfbs" "CFEngine Build System manual"
.TH CFBS "1" "2025\-07\-01" "cfbs" "CFEngine Build System manual"
.SH NAME
cfbs \- combines multiple modules into 1 policy set to deploy on your infrastructure. Modules can be custom promise types, JSON files which enable certain functionality, or reusable CFEngine policy. The modules you use can be written by the CFEngine team, others in the community, your colleagues, or yourself.
.SH SYNOPSIS
Expand All @@ -9,8 +9,8 @@ CFEngine Build System.

.TP
\fBcmd\fR
The command to perform (pretty, init, status, search, add, remove, clean, update, validate, download, build, install, help, info, show,
analyse, analyze, input, set\-input, get\-input, generate\-release\-information)
The command to perform (pretty, init, status, search, add, remove, clean, update, validate, download, build, install, help,
info, show, analyse, analyze, input, set\-input, get\-input, generate\-release\-information)

.TP
\fBargs\fR
Expand Down Expand Up @@ -99,15 +99,17 @@ If the path given to 'cfbs analyze' contains a masterfiles subdirectory, specify

.TP
\fB\-\-ignored\-path\-components\fR \fI\,[IGNORED_PATH_COMPONENTS ...]\/\fR
Specify path components which should be ignored during 'cfbs analyze' (the components should be passed separately, delimited by spaces)
Specify path components which should be ignored during 'cfbs analyze' (the components should be passed separately, delimited by
spaces)

.TP
\fB\-\-offline\fR
Do not connect to the Internet to download the latest version of MPF release information during 'cfbs analyze'

.TP
\fB\-\-masterfiles\fR \fI\,MASTERFILES\/\fR
Add masterfiles on cfbs init choose between
Specify masterfiles version to add during "cfbs init". This can be a branch, a full version number, or `no` to not add
masterfiles at all.

.br
Binary packages may be downloaded from https://cfengine.com/download/.
Expand Down