This is an archive of the discontinued Mercurial Phabricator instance.

amend: add a flag `-n/--note` to store note with amend
ClosedPublic

Authored by pulkit on Oct 15 2017, 10:28 AM.

Download Raw Diff

Details

Reviewers

dlax
yuja
durin42

Group Reviewers

hg-reviewers

Commits

rHG530b7361e3a9: amend: add a flag `-n/--note` to store note with amend
rHGfdec31766a51: amend: add a flag `-n/--note` to store note with amend

Summary

This patch utilises the functionality added in previous patches and adds a flag
to amend command in hgext/amend to add a note to the amend. Since the note is
stored in the obsmarker metadata, this will only be useful when obsmarker
creation is enabled, otherwise this is no-op.

Not adding releasenotes part as we yet don't have a functionality in core to
show the note.

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

pulkit created this revision.Oct 15 2017, 10:28 AM

Herald added a reviewer: hg-reviewers. · View Herald TranscriptOct 15 2017, 10:28 AM

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

dlax accepted this revision.Oct 16 2017, 4:27 AM

Seems fine, though I don't know how the note will be displayed.

FWIW, note cannot be a long sentence due to the storage limit.

$ hg amend --note "$(yes | head -300 | tr -d '\n')"
...
ProgrammingError: obsstore metadata value cannot be longer than 255 bytes ...

This revision is now accepted and ready to land.Oct 16 2017, 9:22 AM

In D1095#18504, @yuja wrote:

Seems fine, though I don't know how the note will be displayed.

We don't have a UI to display obsmarker in core, so for now extensions has to do this.

FWIW, note cannot be a long sentence due to the storage limit.
$ hg amend --note "$(yes | head -300 | tr -d '\n')"
...
ProgrammingError: obsstore metadata value cannot be longer than 255 bytes ...

I will follow up to make sure we catch this before.

We don't have a UI to display obsmarker in core, so for now extensions has to do this.

I know. It would be nice if reviewers can know how the planned UI will be
to determine whether only --note option should be in the next release or not.

In D1095#18566, @yuja wrote:

We don't have a UI to display obsmarker in core, so for now extensions has to do this.

I know. It would be nice if reviewers can know how the planned UI will be
to determine whether only --note option should be in the next release or not.

The UI is not completely planned. What I have in my mind is that it will be good thing to show in obsfate, may be smartlog and definitely it will be in obslog. The note can serve better than messages like "rewritten x,y,z". I will be working on improving the UI around obsolete markers thing in the next cycle and will be discussing these all with everyone interested.

durin42 accepted this revision.Oct 16 2017, 9:37 PM

(Thanks to @yuja for reviewing this new feature so I could have more confidence landing the patch this late in the cycle.)

Closed by commit rHGfdec31766a51: amend: add a flag `-n/--note` to store note with amend (authored by pulkit). · Explain WhyOct 16 2017, 9:47 PM

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

			Path	Packages
M			hgext/amend.py (1 line)
M			tests/test-amend.t (8 lines)

Status	Author	Revision
Closed	pulkit	D1095 amend: add a flag `-n/--note` to store note with amend
Closed	pulkit	D1094 cmdutil: pass metadata from amend() to cleanupnodes
Closed	pulkit	D1093 scmutil: add capability to cleanupnodes to take obsmarker metadata

Diff 2875

hgext/amend.py

	cmdtable = {}			cmdtable = {}
	command = registrar.command(cmdtable)			command = registrar.command(cmdtable)

	@command('amend',			@command('amend',
	[('A', 'addremove', None,			[('A', 'addremove', None,
	_('mark new/missing files as added/removed before committing')),			_('mark new/missing files as added/removed before committing')),
	('e', 'edit', None, _('invoke editor on commit messages')),			('e', 'edit', None, _('invoke editor on commit messages')),
	('i', 'interactive', None, _('use interactive mode')),			('i', 'interactive', None, _('use interactive mode')),
				('n', 'note', '', _('store a note on the amend')),
	] + cmdutil.walkopts + cmdutil.commitopts + cmdutil.commitopts2,			] + cmdutil.walkopts + cmdutil.commitopts + cmdutil.commitopts2,
	_('[OPTION]... [FILE]...'),			_('[OPTION]... [FILE]...'),
	inferrepo=True)			inferrepo=True)
	def amend(ui, repo, pats, *opts):			def amend(ui, repo, pats, *opts):
	"""amend the working copy parent with all or specified outstanding changes			"""amend the working copy parent with all or specified outstanding changes

	Similar to :hg:`commit --amend`, but reuse the commit message without			Similar to :hg:`commit --amend`, but reuse the commit message without
	invoking editor, unless ``--edit`` was set.			invoking editor, unless ``--edit`` was set.

	See :hg:`help commit` for more details.			See :hg:`help commit` for more details.
	"""			"""
	with repo.wlock(), repo.lock():			with repo.wlock(), repo.lock():
	if not opts.get('logfile'):			if not opts.get('logfile'):
	opts['message'] = opts.get('message') or repo['.'].description()			opts['message'] = opts.get('message') or repo['.'].description()
	opts['amend'] = True			opts['amend'] = True
	return commands._docommit(ui, repo, pats, *opts)			return commands._docommit(ui, repo, pats, *opts)

tests/test-amend.t

	@ 3 be169c7e8dbe B			@ 3 be169c7e8dbe B
	\|			\|
	\| o 2 26805aba1e60 C			\| o 2 26805aba1e60 C
	\| \|			\| \|
	\| x 1 112478962961 B			\| x 1 112478962961 B
	\|/			\|/
	o 0 426bada5c675 A			o 0 426bada5c675 A

				Checking the note stored in the obsmarker

				$ echo foo > bar
				$ hg add bar
				$ hg amend --note "adding bar"
				$ hg debugobsolete -r .
				112478962961147124edd43549aedd1a335e44bf be169c7e8dbe21cd10b3d79691cbe7f241e3c21c 0 (Thu Jan 01 00:00:00 1970 +0000) {'operation': 'amend', 'user': 'test'}
				be169c7e8dbe21cd10b3d79691cbe7f241e3c21c 16084da537dd8f84cfdb3055c633772269d62e1b 0 (Thu Jan 01 00:00:00 1970 +0000) {'note': 'adding bar', 'operation': 'amend', 'user': 'test'}
	#endif			#endif

	Cannot amend public changeset			Cannot amend public changeset

	$ hg phase -r A --public			$ hg phase -r A --public
	$ hg update -C -q A			$ hg update -C -q A
	$ hg amend -m AMEND			$ hg amend -m AMEND
	abort: cannot amend public changesets			abort: cannot amend public changesets

Diff	ID	Description	Created	Lint	Unit
Base		Base
Diff 1	2785		Oct 15 2017, 10:28 AM	★	★
Diff 2	2875	rHGfdec31766a51214d85382b4b3b19a4a43fc8ccff	Oct 15 2017, 9:59 AM	★	★