Merge ~mclemenceau/casper:master into casper:master

Proposed by Matthieu Clemenceau
Status: Merged
Merged at revision: 9e721bb4326fe50983509c3200dc99876d142a66
Proposed branch: ~mclemenceau/casper:master
Merge into: casper:master
Diff against target: 86 lines (+31/-6)
2 files modified
debian/changelog (+6/-0)
debian/manpage/casper.7 (+25/-6)
Reviewer Review Type Date Requested Status
Dimitri John Ledkov just an fyi for the future Approve
Review via email: mp+383906@code.launchpad.net

Commit message

document more cmdline options available (LP: #1875548)

Description of the change

Proposed update to casper man page to reflect some undocumented cmdline options
In (LP: #1875548) people wonder how to disable the boot file system check.
The options wasn't documented anywhere.
I reviewed casper sources and identified cmdline options that were not documented in the man page.

To post a comment you must log in.
Revision history for this message
Dimitri John Ledkov (xnox) wrote :

Really good!

review: Approve
Revision history for this message
Dimitri John Ledkov (xnox) wrote :

If the git changelog was formatted like this:

"""
Update manpage with undocumented cmdline options

LP: #1875548
"""

gbp dch (from git-buildpackage) could have been used to autogenerate debian/changelog.

Also, style wise. Normally one just ends the changelog entry with "(LP: #NNNN)" or "LP: #NNNN" without explicitely making it a sentence i.e. "Resolve (LP: #NNNN)". It is widely understood that LP: # closes a bug number.

review: Approve (just an fyi for the future)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/debian/changelog b/debian/changelog
2index 7946eec..e520a6b 100644
3--- a/debian/changelog
4+++ b/debian/changelog
5@@ -1,3 +1,9 @@
6+casper (1.446ubuntu1) UNRELEASED; urgency=medium
7+
8+ * Updated cmdline options in casper manpage documentation. Resolve (LP: #1875548)
9+
10+ -- Matthieu Clemenceau <matthieu.clemenceau@canonical.com> Tue, 12 May 2020 16:29:57 -0500
11+
12 casper (1.446) groovy; urgency=medium
13
14 * control: add fdisk dependency
15diff --git a/debian/manpage/casper.7 b/debian/manpage/casper.7
16index 303afa1..3ee0629 100644
17--- a/debian/manpage/casper.7
18+++ b/debian/manpage/casper.7
19@@ -18,10 +18,13 @@ This enables a special "serial" login shell (experimental).
20 .B xdebconf
21 uses xdebconfigurator, if present on the rootfs, to configure X instead of the standard procedure (experimental).
22 .TP
23+.BI fsck.mode=skip
24+Let you skip the file system check on boot.
25+.TP
26 .BI "hostname=" HOSTNAME " , userfullname=" USERFULLNAME " , username=" USERNAME
27 Those parameters lets you override values read from the config file.
28 .TP
29-.BI "{keyb|kbd-chooser/method}=" KEYBOARD " , {klayout|console-setup/layoutcode}=" LAYOUT " , {kvariant|console-setup/variantcode}=" VARIANT " , {kmodel|console-setup/modelcode}=" CODE " , koptions=" OPTIONS
30+.BI "{keyb|kbd-chooser/method}=" KEYBOARD " , {klayout|console-setup/layoutcode|keyboard-configuration/layoutcode}=" LAYOUT " , {kvariant|console-setup/variantcode|keyboard-configuration/variantcode}=" VARIANT " , {kmodel|console-setup/modelcode|keyboard-configuration/modelcode}=" CODE " , koptions=" OPTIONS
31 Configure the running keyboard as specified, if this one misses casper behaves as if "keyb=us" was specified. It will be interfered from "locale=" if locale is only 2 lowecase letters as a special case. You could also specify console layout, variant, code, and options (no defaults).
32 .TP
33 .BI ip= IFACE,ADDRESS,NETMASK,GATEWAY [ :IFACE,ADDRESS,NETMASK,GATEWAY "]*"
34@@ -42,13 +45,16 @@ Sets the path to the live filesystem on the medium. By default, it is set to "/c
35 .BI "layerfs-path=" PATH
36 Sets the path to the leaf layer of an overlay-compatible multi-layer live filesystem on the medium. By default, it is not set and multi layer is disabled and falls back to the default behaviour of casper. A relative path uses "live-mediate-path" as root directory. All the layer images of the same hierarchy must be in the same directory.
37 .TP
38-.BI "locale=" LOCALE " | debian-installer/locale=" LOCALE
39-Configure the running locale as specified, if not present the live-media rootfs configured locale will be used and if also this one misses casper behave as "locale=en_US.UTF-8" was specified. If only 2 lowercase letter are specified (like "it"), the "maybe wanted" locale is generated (like it:IT.UTF-8), in this case if also "keyb=" is unspecified is set with those 2 lowercase letters (keyb=it).
40+.BI "locale=" LOCALE " | debian-installer/locale=" LOCALE | debian-installer/language=" LANG
41+Configure the running locale as specified, if not present the live-media rootfs configured locale will be used and if also this one misses casper behave as "locale=en_US.UTF-8" was specified. If only 2 lowercase letter are specified (like "it"), the "maybe wanted" locale is generated (like it:IT.UTF-8), in this case if also "keyb=" is unspecified is set with those 2 lowercase letters (keyb=it). if debian-installer/language is set, it will choose the appropriate locale corresponding to this language (it,fr,us,...)
42+.TP
43+.BI debian-installer/driver-update=
44+Add a ubiquity hook to install driver-updates to the target system.
45 .TP
46 .BR "netboot[=" nfs "|" cifs "|" url ]
47 This tells casper to perform a network mount. The parameter "nfsroot=" (with optional "nfsopts="), should specify where is the location of the root filesystem. With no args, will try cifs first, and if it fails nfs. If url method is chosen, "url=" parameter should point to the location of the ".iso" that will be downloaded and mounted. Note "url=" on the commandline alone, by default sets "netboot=url" method too.
48 .TP
49-.BR "url=" URL
50+.BI preseed/url|url= URL
51 This tells casper the download location of the installer ISO. The ISO will be downloaded and mounted. Networking is required for this option to work, which can be configured with "ip=" option. Note, setting this option, will also set "netboot=url" method.
52 .TP
53 .B persistent
54@@ -60,10 +66,13 @@ disables the above mentioned "persistent" feature, useful if the bootloader (lik
55 .BI "persistent-path=" PATH
56 Casper will look for persistency files in the root directory of a partition. With this parameter, the path can be configured so that you can have multiple directories on the same partition to store persistency files.
57 .TP
58-.B "showmounts"
59+.B serialtty=tty
60+Redirect output to tty of choice for debugging purposes in live sessions
61+.TP
62+.B showmounts|show-cow
63 This parameter will make casper to show on "/" the ro filesystems (mostly compressed) on /casper. This is not enabled by default because could lead to problems by applications like "mono" which store binary paths on installation.
64 .TP
65-.B textonly
66+.B textonly|automatic-ubiquity|only-ubiquity|noninteractive
67 Start up to text-mode shell prompts, disabling the graphical user interface.
68 .TP
69 .BI "todisk=" DEVICE
70@@ -94,6 +103,16 @@ may be told to generate a UUID by setting CASPER_GENERATE_UUID=1 when building t
71 .TP
72 .BI noprompt
73 Do not prompt to eject the CD on reboot.
74+.TP
75+.BI access=[v1|v2|v3|m1|m2]
76+Adding this parameter will tune the graphic configuration to different accessibility needs.
77+access=v1 for Lesser Visual Impairment, access=v2 for Moderate Visual Impairment, access=v3 for Blindness, access=m1 for Minor motor difficulties and access and m2 for Motor difficulties with pointing devices.
78+.TP
79+.BI braille=ask
80+Adding this parameter will enable graphic configuration for screen reader.
81+.TP
82+.BI xforcevesa
83+Create basic xorg.conf to force VESA mode only which could help if no suitable video driver is available
84
85 .SH FILES
86 .B /etc/casper.conf

Subscribers

People subscribed via source and target branches