Opened 7 months ago

Closed 7 months ago

#30059 closed defect (fixed)

Update chutney's README

Reported by: teor Owned by: teor
Priority: Medium Milestone:
Component: Core Tor/Chutney Version:
Severity: Normal Keywords: doc, chutney-ci, network-team-roadmap-2019-Q1Q2
Cc: teor Actual Points: 0.2
Parent ID: #29729 Points: 0.2
Reviewer: nickm Sponsor: Sponsor19

Description

In #29729, I discovered some missing information in Chutney's README.

Child Tickets

Change History (4)

comment:1 Changed 7 months ago by teor

Reviewer: nickm
Status: assignedneeds_review

See my pull request:
https://github.com/torproject/chutney/pull/16

Assigning nickm as reviewer, because this is part of #29729.

comment:2 Changed 7 months ago by nickm

Status: needs_reviewmerge_ready

LGTM though I think another branch I just reviewed changes CHUTNEY_START_TIME to 120.

Maybe we should stop mentioning default values inline, and instead have their documentation be automagically generated somehow. We seem to change them a lot. (That could be another ticket though.)

comment:3 in reply to:  2 Changed 7 months ago by teor

Replying to nickm:

LGTM though I think another branch I just reviewed changes CHUTNEY_START_TIME to 120.

You're right, I'll fix the docs when I merge that branch.

Maybe we should stop mentioning default values inline, and instead have their documentation be automagically generated somehow. We seem to change them a lot. (That could be another ticket though.)

I opened #30153 for this change: I think we need to be able to print the defaults using a chutney command. Then we can stop mentioning the defaults inline (or autogenerate the docs).

comment:4 Changed 7 months ago by teor

Resolution: fixed
Status: merge_readyclosed

Merged to master.

I merged #30059, #30063, #30064, and #30065, then pushed.

Note: See TracTickets for help on using tickets.