group.of.nepali.translators team mailing list archive
-
group.of.nepali.translators team
-
Mailing list archive
-
Message #08375
[Bug 1351085] Re: documentation is out of date and sparse
This bug was fixed in the package curtin - 0.1.0~bzr425-0ubuntu1~16.04.1
---------------
curtin (0.1.0~bzr425-0ubuntu1~16.04.1) xenial-proposed; urgency=medium
[ Scott Moser ]
* debian/new-upstream-snapshot: add writing of debian changelog entries.
[ Ryan Harper ]
* New upstream snapshot.
- unittest,tox.ini: catch and fix issue with trusty-level mock of open
- block/mdadm: add option to ignore mdadm_assemble errors (LP: #1618429)
- curtin/doc: overhaul curtin documentation for readthedocs.org
(LP: #1351085)
- curtin.util: re-add support for RunInChroot (LP: #1617375)
- curtin/net: overhaul of eni rendering to handle mixed ipv4/ipv6 configs
- curtin.block: refactor clear_holders logic into block.clear_holders and
cli cmd
- curtin.apply_net should exit non-zero upon exception. (LP: #1615780)
- apt: fix bug in disable_suites if sources.list line is blank.
- vmtests: disable Wily in vmtests
- Fix the unittests for test_apt_source.
- get CURTIN_VMTEST_PARALLEL shown correctly in jenkins-runner output
- fix vmtest check_file_strippedline to strip lines before comparing
- fix whitespace damage in tests/vmtests/__init__.py
- fix dpkg-reconfigure when debconf_selections was provided.
(LP: #1609614)
- fix apt tests on non-intel arch
- Add apt features to curtin. (LP: #1574113)
- vmtest: easier use of parallel and controlling timeouts
- mkfs.vfat: add force flag for formating whole disks (LP: #1597923)
- block.mkfs: fix sectorsize flag (LP: #1597522)
- block_meta: cleanup use of sys_block_path and handle cciss knames
(LP: #1562249)
- block.get_blockdev_sector_size: handle _lsblock multi result return
(LP: #1598310)
- util: add target (chroot) support to subp, add target_path helper.
- block_meta: fallback to parted if blkid does not produce output
(LP: #1524031)
- commands.block_wipe: correct default wipe mode to 'superblock'
- tox.ini: run coverage normally rather than separately
- move uefi boot knowledge from launch and vmtest to xkvm
-- Ryan Harper <ryan.harper@xxxxxxxxxxxxx> Mon, 03 Oct 2016 13:43:54
-0500
** Changed in: curtin (Ubuntu Xenial)
Status: Fix Committed => Fix Released
--
You received this bug notification because you are a member of नेपाली
भाषा समायोजकहरुको समूह, which is subscribed to Xenial.
Matching subscriptions: Ubuntu 16.04 Bugs
https://bugs.launchpad.net/bugs/1351085
Title:
documentation is out of date and sparse
Status in curtin:
Fix Committed
Status in curtin package in Ubuntu:
Fix Released
Status in curtin source package in Xenial:
Fix Released
Bug description:
[Impact]
* Curtin documentation is out-of-date and sparse.
Curtin has been updated to include detailed documentation about
its configuration, features, function and implementation. The
latest configuration is now available at:
http://curtin.readthedocs.io/en/latest/
[Test Case]
n/a
[Regression Potential]
n/a
[Original Description]
The only documentation I could find curtin is doc/topics/overview.rst
in the source. It has several problems:
- It talks about a final_commands hook which doesn't exist AFAICS
- It doesn't talk about the late_commands hook which definitely does
exist
- It refers to both TARGET_MOUNT_POINT and TARGET_MP; I suspect only
one exists
- It has confusing examples which I don't think work/make sense, e.g:
| config_hook: {{TARGET_MP}}/opt/curtin/config-hook
The documentation is also pretty sparse in many ways, it doesn't for
example:
- Explain that the config is YAML
- Explain other basic things about the config, e.g. what are the keys
for hooks? Do the names matter? Does ordering matter?
- Explain why you might want to use a list versus scalar for values
- Explain how one might use YAML features such as 'repeated notes' to
include data in the config that's intended for files
- Explain that you probably want to use -- with curtin in-target to
stop options of what you're trying to run being swallowed up by
curtin
To manage notifications about this bug go to:
https://bugs.launchpad.net/curtin/+bug/1351085/+subscriptions