summaryrefslogtreecommitdiff
path: root/content/digarden/20210410205030-emacs_vc.org
blob: 263d281ab111558cd4d1444dd8767a62e27bf03f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
:PROPERTIES:
:ID:       b0c8ec58-f9a1-4ea0-827f-70f447840fc0
:END:
#+title: emacs-vc
* Emacs VC
Встроенный модуль для работы с системами контроля версий в [[id:981dfcf0-ce4a-4215-bbce-3a745d7d0b4d][Emacs]].

Встроенная поддержка есть для следующих модулей
#+begin_src emacs-lisp :results list
  vc-handled-backends
#+end_src

#+RESULTS:
- RCS
- CVS
- SVN
- SCCS
- SRC
- Bzr
- Git
- Hg
- Mtn

Доступны интерфейсы к известным системам контроля версий:
- Git
- Mercurial
- Subversion
- Darcs

И менее известным:
- rcs
- CVS
- MetaCVS
- GNU Arch
- sccs
- SourceSafe
- ClearCase

Часть из интерфейсов доступна при помощи установки стороннего расширения.

[[https://www.gnu.org/software/emacs/manual/html_node/emacs/Version-Control.html][Документация]]
или
#+begin_src bash :results none
  info emacs vc
#+end_src

* История модуля VC
** Основан на [[https://www.gnu.org/software/rcs/][GNU Rcs]] 
  Rcs -- древняя централизированная система контроля версий от проекта
  GNU. Проект живой, но неизвестно кем используется.
** Подробнее об истории
   [[https://alexott.net/en/writings/emacs-vcs/EmacsVC.html][История модуля VC (AlexOtt)]]


* Как работать с ним
** Начало
   Инициализация проекта предполагается через cli утилиту вашей системы контроля
   версий. Вроде:   
   #+begin_src bash
     mkdir ~/projects/emacs-vc
     cd ~/projects/emacs-vc
     git init .
   #+end_src

#+RESULTS:
: Инициализирован пустой репозиторий Git в /home/w96k/projects/emacs-vc/.git/

  Общий вид доступен по команде vc-dir
  
  #+begin_src emacs-lisp :results none
    (vc-dir "~/projects/emacs-vc")
  #+end_src

** Альтернативы командам git
*** git add
    В VC так называется "регистрация" файла. Можно выполнить напрямую через
    команду ~M-x vc-register~, но в VC воркфлоу несколько иной.

    Создадим файл и добавим
    #+begin_src emacs-lisp :results none
      (find-file "~/projects/emacs-vc/file1.el")
      (insert "(+ 2 (* 2 2))")
      (save-some-buffers)
    #+end_src

*** git reset
    Откат изменений происходит при помощи ~M-x vc-revert~ или сочетания клавиш ~C-x
    v u~.

    Для разрешения конфликтов ~M-x vc-resolve-conflicts~.

*** git branch
    Для создания ветки ~M-x vc-create-tag~ или бинд ~C-x v s
    Для смены ветки ~M-x vc-retrieve-tag~ или бинд ~C-x v r~

*** git merge
    Слияние веток происходит при помощи ~vc-merge~

** Воркфлоу в VC
    В любой непонятной ситуации используешь ~M-x vc-next-action~ или бинд ~C-x v v~
        
    - Если файл не зарегистрирован, то он регистрируется, но изменения не подтверждаются;
    - Если файл уже был добавлен, но не подтвержден, то это изменение подтверждается;
    - Если файл был изменен, а "главный" файл нет, то ваши изменения подтверждаются после ввода описания изменений;
    - Если файл в репозитории был изменен, то пользователю выдадут запрос на слияние изменений в ваш рабочий файл.

** Ссылки
- [[https://snarfed.org/emacs-vc-git-tweaks][Emacs VC Tricks]]