doomemacs/modules/emacs/vc/README.org

62 lines
1.8 KiB
Org Mode
Raw Normal View History

# -*- mode: doom-docs-org -*-
#+title: :emacs vc
#+subtitle: Be the difference you want to see in the fringe
#+created: February 20, 2017
#+since: 2.0.0
* Description :unfold:
This module augments Emacs builtin version control support and provides better
integration with =git=.
2020-05-23 16:59:12 -04:00
** Maintainers
- [[doom-user:][@hlissner]]
[[doom-contrib-maintainer:][Become a maintainer?]]
** Module flags
/This module has no flags./
** Packages
- [[doom-package:][browse-at-remote]]
- [[doom-package:][git-timemachine]]
- [[doom-package:][gitconfig-mode]]
- [[doom-package:][gitignore-mode]]
2020-05-23 16:59:12 -04:00
** Hacks
- Allow [[doom-package:][browse-at-remote]] commands in [[doom-package:][git-timemachine]] buffers to open that file
in your browser at the visited revision.
- [[doom-package:][git-timemachine]] buffers will display revision details in the header-line,
rather than the minibuffer (easier to see).
- [[doom-package:][browse-at-remote]] will fall back to the =master= branch if target is in a
detached state.
2020-05-23 16:59:12 -04:00
** TODO Changelog
# This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./
2020-05-23 16:59:12 -04:00
* Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
2020-05-23 16:59:12 -04:00
This module only requires [[https://git-scm.com/][Git]].
* TODO Usage
#+begin_quote
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote
2020-05-23 16:59:12 -04:00
* TODO Configuration
#+begin_quote
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote
* Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]]
* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
2020-05-23 16:59:12 -04:00
* TODO Appendix
#+begin_quote
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote