Backport documentation and help text rework

Bug #1714966 reported by Stefan Bader on 2017-09-04
12
This bug affects 1 person
Affects Status Importance Assigned to Milestone
ubuntu-fan (Ubuntu)
Low
Unassigned
Xenial
Low
Stefan Bader
Zesty
Low
Stefan Bader

Bug Description

SRU justification:

Impact:
After substantially enhancing all of the documentation (README and man pages) as well as the output of built-in help of fanatic, we should backport those changes to Zesty and Xenial.

Fixes:
  * fanatic: recast advanced commands as non-interactive
  * fanatic: fix spelling in primary help
  * fanatic: fix references to fanatic manual page
  * fanatic: Fix typo in progress output
  * README: Refresh documentation
  * fanctl.8: Refresh documentation
  * fanatic.8: Refresh documentation
  * fanatic.8: Reword advanced to non-interactive usage

Test case:
Since all changes affect only documentation, there is no test case.

Regression risk:
Very low (documentation only)

Stefan Bader (smb) on 2017-09-04
Changed in ubuntu-fan (Ubuntu Xenial):
assignee: nobody → Stefan Bader (smb)
importance: Undecided → Low
status: New → In Progress
Changed in ubuntu-fan (Ubuntu Zesty):
assignee: nobody → Stefan Bader (smb)
importance: Undecided → Low
status: New → In Progress
Changed in ubuntu-fan (Ubuntu):
assignee: Stefan Bader (smb) → nobody
importance: Undecided → Low
status: In Progress → Fix Released
Stefan Bader (smb) on 2017-09-20
description: updated

Hello Stefan, or anyone else affected,

Accepted ubuntu-fan into zesty-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/ubuntu-fan/0.12.4~17.04.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed.Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested and change the tag from verification-needed-zesty to verification-done-zesty. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-zesty. In either case, details of your testing will help us make a better decision.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance!

Changed in ubuntu-fan (Ubuntu Zesty):
status: In Progress → Fix Committed
tags: added: verification-needed verification-needed-zesty
Stefan Bader (smb) wrote :

Verified new man page content with proposed version in zesty (0.12.4~17.04.1).

tags: added: verification-done-zesty
removed: verification-needed-zesty
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package ubuntu-fan - 0.12.4~17.04.1

---------------
ubuntu-fan (0.12.4~17.04.1) zesty; urgency=medium

  [ Andy Whitcroft ]
  * fanctl: only bring up enabled Fan Networks in --auto mode (LP: #1707610)
  * fanctl: correctly specify local interface specific config (LP: #1707610)
  * fanatic: recast advanced commands as non-interactive (LP: #1714966)
  * fanatic: fix spelling in primary help (LP: #1714966)
  * fanatic: fix references to fanatic manual page (LP: #1714966)

  [ Stefan Bader ]
  * fanatic: Fix typo in progress output (LP: #1714966)
  * README: Refresh documentation (LP: #1714966)
  * fanctl.8: Refresh documentation (LP: #1714966)
  * fanatic.8: Refresh documentation (LP: #1714966)
  * fanatic.8: Reword advanced to non-interactive usage (LP: #1714966)
  * DEP8: lxd: Suppress stderr on profile list (LP: #1714969)

 -- Stefan Bader <email address hidden> Fri, 18 Aug 2017 14:34:47 +0200

Changed in ubuntu-fan (Ubuntu Zesty):
status: Fix Committed → Fix Released

The verification of the Stable Release Update for ubuntu-fan has completed successfully and the package has now been released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.

Hello Stefan, or anyone else affected,

Accepted ubuntu-fan into xenial-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/ubuntu-fan/0.12.7~16.04.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed.Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested and change the tag from verification-needed-xenial to verification-done-xenial. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-xenial. In either case, details of your testing will help us make a better decision.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance!

Changed in ubuntu-fan (Ubuntu Xenial):
status: In Progress → Fix Committed
tags: added: verification-needed-xenial
Łukasz Zemczak (sil2100) wrote :

Hello Stefan, or anyone else affected,

Accepted ubuntu-fan into xenial-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/ubuntu-fan/0.12.8~16.04.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed.Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested and change the tag from verification-needed-xenial to verification-done-xenial. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-xenial. In either case, details of your testing will help us make a better decision.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance!

Stefan Bader (smb) wrote :

Verified the documentation changes in the proposed Xenial package.

tags: added: verification-done verification-done-xenial
removed: verification-needed verification-needed-xenial
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package ubuntu-fan - 0.12.8~16.04.1

---------------
ubuntu-fan (0.12.8~16.04.1) xenial; urgency=medium

  * fanatic: Optionally provide DNS server for docker test (LP: #1732717)

ubuntu-fan (0.12.7~16.04.1) xenial; urgency=medium

  * fanctl: cmd_up needs to proparate scan_config errors (LP: #1719644)
  * fanatic: Clean up config if bringup fails (LP: #1728050)

ubuntu-fan (0.12.6~16.04.1) xenial; urgency=medium

  [ 0.12.5 ]
  * DEP8: Fix LXD default interface detection (LP: #1732739)
  * fanctl: return error on fail_up (LP: #1719644)

  [ 0.12.6 ]
  * fanatic: Add short success delay to nc_send (LP: #1721352)
  * fanatic: Catch test preparation steps failing (LP: #1735183)
  * fanatic: Add DNS checks to local-test preparation (LP: #1732747)

ubuntu-fan (0.12.4~16.04.1) xenial; urgency=medium

  [ Andy Whitcroft ]
  * fanctl.8: fix interfane type (LP: #1584845)
  * debian/control: fix use of obsolete > operator (LP: #1714969)
  * fanctl: only bring up enabled Fan Networks in --auto mode (LP: #1707610)
  * fanctl: correctly specify local interface specific config (LP: #1707610)
  * fanatic: recast advanced commands as non-interactive (LP: #1714966)
  * fanatic: fix spelling in primary help (LP: #1714966)
  * fanatic: fix references to fanatic manual page (LP: #1714966)

  [ Stefan Bader ]
  * fanatic: fix local testing and improve docker test (LP: #1714969)
  * fanatic: Support nc -N option (LP: #1714969)
  * fanatic: Prevent error message without docker installed (LP: #1714969)
  * fanatic: Supply LXD storage if needed (LP: #1714969)
  * dep8: Add LXD auto-test (LP: #1714969)
  * fanatic: Fix typo in progress output (LP: #1714966)
  * README: Refresh documentation (LP: #1714966)
  * fanctl.8: Refresh documentation (LP: #1714966)
  * fanatic.8: Refresh documentation (LP: #1714966)
  * fanatic.8: Reword advanced to non-interactive usage (LP: #1714966)
  * DEP8: lxd: Suppress stderr on profile list (LP: #1714969)

 -- Stefan Bader <email address hidden> Wed, 29 Nov 2017 16:17:26 +0100

Changed in ubuntu-fan (Ubuntu Xenial):
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers