Feature #16903

Refactor tails-documentation

Added by segfault 2019-07-21 17:34:53 . Updated 2020-03-16 07:01:52 .

Status:
Resolved
Priority:
Low
Assignee:
intrigeri
Category:
Target version:
Tails_4.5
Start date:
Due date:
% Done:

100%

Feature Branch:
feature/16903-refactor-tails-documentation
Type of work:
Code
Blueprint:

Starter:
Affected tool:
Deliverable for:

Description

While working on Feature #16664, I had to change a line in tails-documentation, and I couldn’t help but refactor it.

Subtasks

Related issues

Blocked by Tails - Feature #16664: Simplify "Tor has bootstrapped" status check Resolved

History

#1 Updated by segfault 2019-07-21 17:36:25

  • Status changed from Confirmed to In Progress

Applied in changeset commit:tails|4e02f0d1e25c1ec7bd2e80057958a1f9fbdaf114.

#2 Updated by segfault 2019-07-21 17:52:11

  • Feature Branch set to feature/16903-refactor-tails-documentation

#3 Updated by segfault 2019-07-21 17:52:29

  • blocked by Feature #16664: Simplify "Tor has bootstrapped" status check added

#4 Updated by segfault 2019-07-21 17:56:23

Blocked by Feature #16664 because I use tor_has_bootstrapped from tailslib.tor, which can only be used by amnesia after changes I made in Feature #16664.

#5 Updated by segfault 2019-07-21 17:56:37

  • Assignee set to segfault

#6 Updated by segfault 2020-03-08 18:33:43

  • Status changed from In Progress to Needs Validation
  • Assignee deleted (segfault)
  • Target version set to Tails_4.5

segfault wrote:
> Blocked by Feature #16664 because I use tor_has_bootstrapped from tailslib.tor, which can only be used by amnesia after changes I made in Feature #16664.

Feature #16664 was merged so this is not blocked anymore. I also tested again that tails-documentation still works as expected.

#7 Updated by intrigeri 2020-03-09 08:48:00

  • Status changed from Needs Validation to In Progress
  • Assignee set to segfault

Hi! It looks like the branch suffered from a buggy rebase: it includes duplicate commits, that we already have on the stable branch. Perhaps all we need is a branch forked off stable, with commit:4e02f0d1e25c1ec7bd2e80057958a1f9fbdaf114 cherry-picked on top?

#8 Updated by segfault 2020-03-09 21:07:39

  • Status changed from In Progress to Needs Validation
  • Assignee deleted (segfault)

intrigeri wrote:
> Hi! It looks like the branch suffered from a buggy rebase: it includes duplicate commits, that we already have on the stable branch. Perhaps all we need is a branch forked off stable, with commit:4e02f0d1e25c1ec7bd2e80057958a1f9fbdaf114 cherry-picked on top?

Huh, I wonder how that happened. Anyway, fixed it now.

#9 Updated by intrigeri 2020-03-15 16:56:53

  • Assignee set to intrigeri

#10 Updated by intrigeri 2020-03-15 17:15:23

Code LGTM! This script is used in various places and I’m not sure if any affected test is tagged fragile, so I’ll run the full test suite locally. It seems that we have great automatic test coverage and I assume segfault tested this manually already, so I’ll skip manual testing (worst case, there’s a chance that any problem is spotted in 4.5~rc1).

Despite the overhead that makes the total short-term cost/benefit look pretty high, I’m glad you’re setting the bar higher wrt. code quality/style: having good examples will help new contributors write better code :)

#11 Updated by intrigeri 2020-03-16 07:01:52

  • Status changed from Needs Validation to Resolved
  • % Done changed from 0 to 100

Applied in changeset commit:tails|5484d70626f3519db4d47e44ba252de2041eb0a9.