| 2014-07-31 22:14:44 |
James Troup |
bug |
|
|
added bug |
| 2014-07-31 22:14:52 |
James Troup |
summary |
documentation is out of date |
documentation is out of date and sparse |
|
| 2014-07-31 22:15:01 |
James Troup |
bug |
|
|
added subscriber The Canonical Sysadmins |
| 2014-08-22 19:19:37 |
Blake Rouse |
curtin: status |
New |
Confirmed |
|
| 2014-08-22 19:19:39 |
Blake Rouse |
curtin: importance |
Undecided |
High |
|
| 2014-09-22 16:09:45 |
Adam Stokes |
bug |
|
|
added subscriber Adam Stokes |
| 2016-08-01 18:50:53 |
Ryan Harper |
branch linked |
|
lp:~raharper/curtin/trunk.documentation-update |
|
| 2016-08-29 23:16:53 |
Launchpad Janitor |
branch linked |
|
lp:curtin |
|
| 2016-09-29 18:56:00 |
Launchpad Janitor |
branch linked |
|
lp:~smoser/ubuntu/yakkety/curtin/pkg |
|
| 2016-10-03 18:52:23 |
Launchpad Janitor |
branch linked |
|
lp:~raharper/ubuntu/xenial/curtin/pkg-sru-revno425 |
|
| 2016-10-03 22:11:41 |
Ryan Harper |
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 |
[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 |
|
| 2016-10-05 15:38:24 |
Andy Whitcroft |
bug |
|
|
added subscriber Ubuntu Stable Release Updates Team |
| 2016-10-05 15:38:29 |
Andy Whitcroft |
bug |
|
|
added subscriber SRU Verification |
| 2016-10-05 15:38:35 |
Andy Whitcroft |
tags |
|
verification-needed |
|
| 2016-10-05 15:42:13 |
Andy Whitcroft |
bug task added |
|
curtin (Ubuntu) |
|
| 2016-10-05 15:42:30 |
Andy Whitcroft |
nominated for series |
|
Ubuntu Xenial |
|
| 2016-10-05 15:42:30 |
Andy Whitcroft |
bug task added |
|
curtin (Ubuntu Xenial) |
|
| 2016-10-05 15:49:35 |
Andy Whitcroft |
curtin (Ubuntu): status |
New |
Fix Released |
|
| 2016-10-05 15:49:39 |
Andy Whitcroft |
curtin (Ubuntu Xenial): status |
New |
Fix Committed |
|
| 2016-10-06 19:10:09 |
Jon Grimm |
curtin: status |
Confirmed |
Fix Committed |
|
| 2016-10-06 19:14:46 |
Jon Grimm |
tags |
verification-needed |
verification-done |
|
| 2016-10-17 03:58:02 |
Launchpad Janitor |
curtin (Ubuntu Xenial): status |
Fix Committed |
Fix Released |
|
| 2016-10-17 03:58:29 |
Martin Pitt |
removed subscriber Ubuntu Stable Release Updates Team |
|
|
|
| 2017-12-15 22:08:40 |
Scott Moser |
curtin: status |
Fix Committed |
Fix Released |
|
