Mercurial > vim-lawrencium

comparison doc/lawrencium.txt @ 109:8ec747b13dc1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add `Hgrecord` and a few other things to the documentation.
author Ludovic Chabant <ludovic@chabant.com>
date Mon, 01 Sep 2014 08:41:47 -0700
parents d38be34b403b
children 7cfe9ba2c7dd
comparison
equal deleted inserted replaced
108:497f7a481599 109:8ec747b13dc1
234 *:Hgqseries* 234 *:Hgqseries*
235 :Hgqseries If you have the 'mq' extension enabled, show the 235 :Hgqseries If you have the 'mq' extension enabled, show the
236 current patch series, with indicators about which 236 current patch series, with indicators about which
237 patches are applied, and which ones are not. 237 patches are applied, and which ones are not.
238 238
239 *:Hgrecord*
240 :Hgrecord Starts a "record" operation on the current buffer,
241 i.e. an operation where you can commit a selected
242 subset of all the changes made to a file.
243
244 This actually doesn't run `hg record`, but serves the
245 exact same purpose, hence the name.
246
247 When the command is run, a diff window will be opened
248 between the current buffer and the parent revision's
249 version of the same file. You can then start
250 "recording" changes (by using |do| from the parent
251 revision window, or |dp| from the working directory
252 version). Changes "recorded" into the parent revision
253 window will be committed when that window is closed,
254 so when you're done recording changes, you can just
255 run |:wq|. You can also run |:Hgrecordcommit|, or
256 |:Hgrecordabort| if you want to abort.
257
258 When running |:Hgrecordcommit|, or |:wq| from the
259 parent revision window, a commit window will show up.
260 As with the normal commit window, a commit message
261 should be entered, and |:wq| should be run again.
262 Running |:q!| when the commit message hasn't been
263 saved will abort the record operation.
264
265 To summarize:
266
267 * |:Hgrecord| to start a record operation
268 * Use |do| and |]c| to move from diff hunk to diff
269 hunk, recording those you want to commit.
270 * |:Hgrecordabort| to abort, |:wq| to commit.
271 * If committing, enter the commit message in the
272 commit window, and |:wq| again.
273 * Done!
274
239 275
240 ============================================================================= 276 =============================================================================
241 3. Status Window *lawrencium-status-window* 277 3. Status Window *lawrencium-status-window*
242 278
243 The `hg status` window opened by Lawrencium has a few special commands 279 The `hg status` window opened by Lawrencium has a few special commands
504 Specifies whether to auto-close buffers opened by 540 Specifies whether to auto-close buffers opened by
505 Lawrencium. For instance, any diff summary buffer open 541 Lawrencium. For instance, any diff summary buffer open
506 by `Hglog` will be deleted when the log window 542 by `Hglog` will be deleted when the log window
507 disappears. 543 disappears.
508 544
545 *lawrencium_status_win_split_above*
546 g:lawrencium_status_win_split_above
547 If set to 1, |Hgstatus| will open in a split window
548 above the current window, instead of below.
549 Defaults to `0`.
550
551 *lawrencium_status_win_split_even*
552 g:lawrencium_status_win_split_even
553 If set to 1, |Hgstatus| will open a split window by
554 splitting the current window in half. Otherwise, it
555 will open a split window of roughly the size needed to
556 show all modified files.
557 Defaults to `0`.
558
559 *lawrencium_record_start_in_working_buffer*
560 g:lawrencium_record_start_in_working_buffer
561 If set to 1, |Hgrecord| will leave focus in the
562 working directory buffer, instead of the recording
563 buffer.
564 Defaults to `0`.
565
509 vim:tw=78:et:ft=help:norl: 566 vim:tw=78:et:ft=help:norl: