This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5526

progress: document progress.debug config option
ClosedPublic

Authored by martinvonz on Jan 8 2019, 1:10 PM.

Download Raw Diff

Details

Reviewers

pulkit

Group Reviewers

hg-reviewers

Commits

rHG785a75f0ddcb: progress: document progress.debug config option

Summary

I think it was not spotted by test-check-config.t that we had not
documented it because no caller refers to the ui object simply as "ui"
(it was either "self.ui" or just "self").

Diff Detail

Repository

rHG Mercurial

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

Event Timeline

martinvonz created this revision.Jan 8 2019, 1:10 PM

Herald added a reviewer: hg-reviewers. · View Herald TranscriptJan 8 2019, 1:10 PM

Herald added a subscriber: mercurial-devel. · View Herald Transcript

martinvonz added a child revision: D5527: progress: write ui.progress() in terms of ui.makeprogress().Jan 8 2019, 1:10 PM

pulkit accepted this revision.Jan 8 2019, 2:06 PM

Closed by commit rHG785a75f0ddcb: progress: document progress.debug config option (authored by martinvonz). · Explain WhyJan 8 2019, 2:15 PM

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

			Path	Packages
M			mercurial/help/config.txt (3 lines)

Status	Author	Revision
Closed	martinvonz	D5531 progress: deprecate ui.progress()
Closed	martinvonz	D5530 progress: check what type of progress bar to use only once per topic
Closed	martinvonz	D5529 progress: split up _print() method in bar-updating and debug-printing
Closed	martinvonz	D5528 progress: move cached debug flag from progress.progbar to scmutil.progress
Closed	martinvonz	D5527 progress: write ui.progress() in terms of ui.makeprogress()
Closed	martinvonz	D5526 progress: document progress.debug config option

Diff 13083

mercurial/help/config.txt


	``progress``			``progress``
	------------			------------

	Mercurial commands can draw progress bars that are as informative as			Mercurial commands can draw progress bars that are as informative as
	possible. Some progress bars only offer indeterminate information, while others			possible. Some progress bars only offer indeterminate information, while others
	have a definite end point.			have a definite end point.

				``debug``
				Whether to print debug info when updating the progress bar. (default: False)

	``delay``			``delay``
	Number of seconds (float) before showing the progress bar. (default: 3)			Number of seconds (float) before showing the progress bar. (default: 3)

	``changedelay``			``changedelay``
	Minimum delay before showing a new topic. When set to less than 3 * refresh,			Minimum delay before showing a new topic. When set to less than 3 * refresh,
	that value will be used instead. (default: 1)			that value will be used instead. (default: 1)

	``estimateinterval``			``estimateinterval``

Diff	ID	Description	Created	Lint	Unit
Base		Base
Diff 1	13076		Jan 8 2019, 1:10 PM	★	★
Diff 2	13083	rHG785a75f0ddcb88bd0c6c7eea164ec94ee97c0e61	Jan 8 2019, 12:43 PM	★	★