dotfiles/.vim/pack/plugins/start/vim-conflict-marker/doc/conflict-marker.txt
2024-12-15 14:45:59 +01:00

177 lines
5.1 KiB
Plaintext

*conflict-marker.txt* a weapon to fight against conflicts
Author : rhysd <lin90162@yahoo.co.jp>
CONTENTS *conflict-marker.vim-contents*
Introduction |conflict-marker.vim-introduction|
Usage |conflict-marker.vim-usage|
Mappings |conflict-marker.vim-mappings|
Variables |conflict-marker.vim-variables|
Repository Page |conflict-marker.vim-repository-page|
License |conflict-marker.vim-license|
==============================================================================
INTRODUCTION *conflict-marker.vim-introduction*
*conflict-marker.vim* is a plugin for developers fighting against conflicts.
All features are available iff an opened buffer contains a conflict marker.
conflict-marker.vim does
1. highlight conflict markers.
2. jump among conflict markers.
3. jump within conflict block; begin, separator and end of the block.
4. resolve conflict with various strategies; "theirs", "ours", "none"
and "both".
==============================================================================
USAGE *conflict-marker.vim-usage*
Please see README.md in below repository page. TODO
https://github.com/rhysd/conflict-marker.vim/blob/master/README.md
==============================================================================
MAPPINGS *conflict-marker.vim-mappings*
[x
]x
Jump among Conflict Markers.
Use the following option to disable them: >
let g:conflict_marker_enable_mappings = 0
<
*<Plug>(conflict-marker-next-hunk)*
*<Plug>(conflict-marker-prev-hunk)*
Jump among Conflict Markers.
ct
co
cn
Resolve a Conflict with Various Strategies.
`ct` for theirs, `co` for ours, `cn` for none and `cb` for both.
See |conflict-marker.vim-example| for more details.
Use the following option to disable them: >
let g:conflict_marker_enable_mappings = 0
<
*<Plug>(conflict-marker-themselves)*
*<Plug>(conflict-marker-ourselves)*
*<Plug>(conflict-marker-both)*
*<Plug>(conflict-marker-both-rev)*
*<Plug>(conflict-marker-none)*
Resolve a Conflict with Various Strategies.
See |conflict-marker.vim-example| for more details.
==============================================================================
EXAMPLE *conflict-marker.vim-example*
How this plugin resolves conflicts is shown below.
Theirs: >
<<<<<<< HEAD
ours
=======
theirs
>>>>>>> deadbeef0123
<
↓`ct` or `:ConflictMarkerThemselves` >
theirs
<
Ours: >
<<<<<<< HEAD
ours
=======
theirs
>>>>>>> deadbeef0123
<
↓`co` or `:ConflictMarkerOurselves` >
ours
<
Apply Both: >
<<<<<<< HEAD
ours
=======
theirs
>>>>>>> deadbeef0123
<
↓`cb` or `:ConflictMarkerBoth` >
ours
theirs
<
Apply Both in Reverse Order: >
<<<<<<< HEAD
ours
=======
theirs
>>>>>>> deadbeef0123
<
↓`cB` or `:ConflictMarkerBoth!` >
theirs
ours
<
Apply None: >
<<<<<<< HEAD
ours
=======
theirs
>>>>>>> deadbeef0123
<
↓`cn` or `:ConflictMarkerNone` >
(empty)
<
==============================================================================
VARIABLES *conflict-marker.vim-variables*
Please see README.md in below repository page. TODO
https://github.com/rhysd/conflict-marker.vim/blob/master/README.md
==============================================================================
REPOSITORY PAGE *conflict-marker.vim-repository-page*
The latest version of |conflict-marker.vim| is available at
https://github.com/rhysd/conflict-marker.vim
Contributions (pull requests) are welcome. None of them are too short.
Especially, English check is very helpful because I'm poor at English :(
==============================================================================
LICENSE *conflict-marker.vim-license*
|conflict-marker.vim| is distributed under MIT license.
Copyright (c) 2013 rhysd
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
==============================================================================
vim:tw=78:colorcolumn=78:ts=8:ft=help:norl:noet:fen:fdl=0: