branch: scratch/editorconfig-cc
commit 5986c305c9b7fe98c5b60a64997f914555e1a121
Author: 10sr <8.slas...@gmail.com>
Commit: Stefan Monnier <monn...@iro.umontreal.ca>
Remove .info and add .texi
---
doc/editorconfig.info | 283 --------------------------------------------------
doc/editorconfig.texi | 250 ++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 250 insertions(+), 283 deletions(-)
diff --git a/doc/editorconfig.info b/doc/editorconfig.info
deleted file mode 100644
index 7afd4498d2..0000000000
--- a/doc/editorconfig.info
+++ /dev/null
@@ -1,283 +0,0 @@
-This is docs/editorconfig.info, produced by makeinfo version 4.8 from
-docs/editorconfig.info.texi.
-
-
-File: editorconfig.info, Node: Top, Next: EditorConfig Emacs Plugin, Up:
(dir)
-
-Top
-***
-
-* Menu:
-
-* EditorConfig Emacs Plugin::
-
-
-File: editorconfig.info, Node: EditorConfig Emacs Plugin, Prev: Top, Up: Top
-
-1 EditorConfig Emacs Plugin
-***************************
-
-This is an EditorConfig (http://editorconfig.org) plugin for Emacs
-(https://www.gnu.org/software/emacs/).
-
-* Menu:
-
-* Installation::
-* Supported properties::
-* Customize::
-* Testing::
-* Submitting Bugs and Feature Requests::
-* License::
-
-
-File: editorconfig.info, Node: Installation, Next: Supported properties,
Up: EditorConfig Emacs Plugin
-
-1.1 Installation
-================
-
-Download the EditorConfig C Core
-(https://github.com/editorconfig/editorconfig-core-c) and follow the
-instructions in the README and INSTALL files to install it.
-
-This plugin also has a built-in core library implemented in Emacs-Lisp,
-and fallback to it when no core executable is found.
-
-In either case, copy `.el' files in this repository to
-`~/.emacs.d/lisp' and add the following to your `~/.emacs' file:
-
-
-(add-to-list 'load-path "~/.emacs.d/lisp")
-(require 'editorconfig)
-(editorconfig-mode 1)
-
-Alternatively, you can find the package available on MELPA
-(http://melpa.org/#/editorconfig) and MELPA Stable
-(http://stable.melpa.org/#/editorconfig) (The Marmalade package
-(http://marmalade-repo.org/packages/editorconfig) is deprecated).
-
-Or if you use *use-package*
-(https://www.emacswiki.org/emacs/UsePackage):
-
-
-(use-package editorconfig
- :ensure t
- :config
- (editorconfig-mode 1))
-
-
-File: editorconfig.info, Node: Supported properties, Next: Customize, Prev:
Installation, Up: EditorConfig Emacs Plugin
-
-1.2 Supported properties
-========================
-
-Current Emacs plugin coverage for EditorConfig's properties
-(http://editorconfig.org/#supported-properties):
-
- * `indent_style'
-
- * `indent_size'
-
- * `tab_width'
-
- * `end_of_line'
-
- * `charset'
-
- * `trim_trailing_whitespace'
-
- * `insert_final_newline = true' is supported
-
- * `insert_final_newline = false' is not enforced (as in trailing
- newlines actually being removed automagically), we just
- buffer-locally override any preferences that would auto-add them
- to files `.editorconfig' marks as trailing-newline-free
-
- * `max_line_length'
-
- * `file_type_emacs' (Experimental)
-
- * `root' (only used by EditorConfig core)
-
-Not yet covered properties marked with over-strike - pull requests
-implementing missing features warmly welcomed! Typically, you will want
-to tie these to native functionality, or the configuration of existing
-packages handling the feature.
-
-As several packages have their own handling of, say, indention, we might
-not yet cover some mode you use, but we try to add the ones that show up
-on our radar. Similarly, we don't yet hook in to all different packages
-for whitespace trimming to inform them about editorconfig settings, but
-aim for better coverage of things like ws-trim
-(ftp://ftp.lysator.liu.se/pub/emacs/ws-trim.el).
-
-This plugin also has an experimental support for `file_type_emacs',
-which specifies "file types" for files. As for Emacs, it means
-`major-mode' can be specified: for example, when `file_type_emacs' is
-set to `markdown' for `a.txt', `markdown-mode' will be enabled when
-opening `a.txt'. This property is experimental and its meaning might
-change in the future updates.
-
-
-File: editorconfig.info, Node: Customize, Next: Testing, Prev: Supported
properties, Up: EditorConfig Emacs Plugin
-
-1.3 Customize
-=============
-
-* Menu:
-
-* editorconfig-custom-hooks::
-* editorconfig-indentation-alist::
-* editorconfig-exec-path::
-* editorconfig-get-properties-function::
-
-
-File: editorconfig.info, Node: editorconfig-custom-hooks, Next:
editorconfig-indentation-alist, Up: Customize
-
-1.3.1 `editorconfig-custom-hooks'
----------------------------------
-
-A list of custom hooks after loading common EditorConfig settings, where
-you can set some custom variables or overwrite existing properties.
-
-For example, `web-mode' has several variables for indentation offset
-size and EditorConfig sets them at once by `indent_size'. You may want
-to stop indenting only blocks of `web-mode': it can be achieved by
-adding following to your init.el:
-
-
-(add-hook 'editorconfig-custom-hooks
- (lambda (hash) (setq web-mode-block-padding 0)))
-
-You can also define your own custom properties and enable them here.
-
-
-File: editorconfig.info, Node: editorconfig-indentation-alist, Next:
editorconfig-exec-path, Prev: editorconfig-custom-hooks, Up: Customize
-
-1.3.2 `editorconfig-indentation-alist'
---------------------------------------
-
-Alist of indentation setting methods by modes.
-
-For the easiest case to add a new support for a major-mode, you just
-need to add a pair of major-mode symbol and its indentation variables:
-
-
-(add-to-list 'editorconfig-indentation-alist
- ;; Just an example, of course EditorConfig has already included this setting!
- '(c-mode c-basic-offset))
-
-You can also modify this variable with the command M-x
-customize-variable [RET] editorconfig-indentation-alist [RET]. For a bit
-more complicated cases please take a look at the docstring of this
-variable.
-
-
-File: editorconfig.info, Node: editorconfig-exec-path, Next:
editorconfig-get-properties-function, Prev: editorconfig-indentation-alist,
Up: Customize
-
-1.3.3 `editorconfig-exec-path'
-------------------------------
-
-String of `editorconfig' executable name (command name or full path to
-the executable).
-
-
-File: editorconfig.info, Node: editorconfig-get-properties-function, Prev:
editorconfig-exec-path, Up: Customize
-
-1.3.4 `editorconfig-get-properties-function'
---------------------------------------------
-
-Function to use to get EditorConfig properties.
-
-For example, if you always want to use built-in core library instead of
-any EditorConfig executable to get properties, add following to your
-init.el:
-
-
-(set-variable 'editorconfig-get-properties-function
- #'editorconfig-core-get-properties-hash)
-
-Possible known values are:
-
- * `editorconfig-get-properties' (default)
- * Use `editorconfig-get-properties-from-exec' when
- `editorconfig-exec-path' executable is found, otherwise use
- `editorconfig-core-get-properties-hash'
-
- * `editorconfig-get-properties-from-exec'
- * Get properties by executing EditorConfig executable specified
- in `editorconfig-exec-path'
-
- * `editorconfig-core-get-properties-hash'
- * Always use built-in Emacs-Lisp implementation to get
- properties
-
-
-
-File: editorconfig.info, Node: Testing, Next: Submitting Bugs and Feature
Requests, Prev: Customize, Up: EditorConfig Emacs Plugin
-
-1.4 Testing
-===========
-
-Make and CMake (https://cmake.org) must be installed to run the tests.
-
-To run the tests:
-
-
-$ make test
-
-
-File: editorconfig.info, Node: Submitting Bugs and Feature Requests, Next:
License, Prev: Testing, Up: EditorConfig Emacs Plugin
-
-1.5 Submitting Bugs and Feature Requests
-========================================
-
-Bugs, feature requests, and other issues should be submitted to the
-issue tracker: https://github.com/editorconfig/editorconfig-emacs/issues
-
-
-File: editorconfig.info, Node: License, Prev: Submitting Bugs and Feature
Requests, Up: EditorConfig Emacs Plugin
-
-1.6 License
-===========
-
-EditorConfig Emacs Plugin is free software: you can redistribute it
-and/or modify it under the terms of the GNU General Public License as
-published by the Free Software Foundation, either version 3 of the
-License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful, but
-WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
-Public License for more details.
-
-You should have received a copy of the GNU General Public License along
-with this program. If not, see `https://www.gnu.org/licenses/'.
-
-
-
-Tag Table:
-Node: Top100
-Node: EditorConfig Emacs Plugin234
-Ref: #editorconfig-emacs-plugin374
-Node: Installation612
-Ref: #installation756
-Node: Supported properties1648
-Ref: #supported-properties1826
-Node: Customize3481
-Ref: #customize3632
-Node: editorconfig-custom-hooks3775
-Ref: #editorconfig-custom-hooks3960
-Node: editorconfig-indentation-alist4505
-Ref: #editorconfig-indentation-alist4731
-Node: editorconfig-exec-path5281
-Ref: #editorconfig-exec-path5502
-Node: editorconfig-get-properties-function5591
-Ref: #editorconfig-get-properties-function5801
-Node: Testing6650
-Ref: #testing6813
-Node: Submitting Bugs and Feature Requests6918
-Ref: #submitting-bugs-and-feature-requests7137
-Node: License7279
-Ref: #license7424
-
-End Tag Table
diff --git a/doc/editorconfig.texi b/doc/editorconfig.texi
new file mode 100644
index 0000000000..7488a2d203
--- /dev/null
+++ b/doc/editorconfig.texi
@@ -0,0 +1,250 @@
+\input texinfo
+@documentencoding UTF-8
+
+@ifnottex
+@paragraphindent 0
+@end ifnottex
+@node Top
+@top Top
+
+@menu
+* EditorConfig Emacs Plugin::
+@end menu
+
+@node EditorConfig Emacs Plugin
+@chapter EditorConfig Emacs Plugin
+@anchor{#editorconfig-emacs-plugin}
+This is an @uref{http://editorconfig.org,EditorConfig} plugin for
+@uref{https://www.gnu.org/software/emacs/,Emacs}.
+@menu
+* Installation::
+* Supported properties::
+* Customize::
+* Testing::
+* Submitting Bugs and Feature Requests::
+* License::
+@end menu
+
+@node Installation
+@section Installation
+@anchor{#installation}
+Download the
+@uref{https://github.com/editorconfig/editorconfig-core-c,EditorConfig C
+Core} and follow the instructions in the README and INSTALL files to
+install it.
+
+This plugin also has a built-in core library implemented in Emacs-Lisp,
+and fallback to it when no core executable is found.
+
+In either case, copy @code{.el} files in this repository to
+@code{~/.emacs.d/lisp} and add the following to your @code{~/.emacs}
+file:
+
+@verbatim
+(add-to-list 'load-path "~/.emacs.d/lisp")
+(require 'editorconfig)
+(editorconfig-mode 1)
+@end verbatim
+
+Alternatively, you can find the package available on
+@uref{http://melpa.org/#/editorconfig,MELPA} and
+@uref{http://stable.melpa.org/#/editorconfig,MELPA Stable}
+(@uref{http://marmalade-repo.org/packages/editorconfig,The Marmalade
+package} is deprecated).
+
+Or if you use
+@uref{https://www.emacswiki.org/emacs/UsePackage,@strong{use-package}}:
+
+@verbatim
+(use-package editorconfig
+ :ensure t
+ :config
+ (editorconfig-mode 1))
+@end verbatim
+
+@node Supported properties
+@section Supported properties
+@anchor{#supported-properties}
+Current Emacs plugin coverage for EditorConfig's
+@uref{http://editorconfig.org/#supported-properties,properties}:
+
+@itemize
+@item
+@code{indent_style}
+@item
+@code{indent_size}
+@item
+@code{tab_width}
+@item
+@code{end_of_line}
+@item
+@code{charset}
+@item
+@code{trim_trailing_whitespace}
+@item
+@code{insert_final_newline = true} is supported
+@item
+@code{insert_final_newline = false}
+is not enforced (as in trailing newlines actually being removed
+automagically), we just buffer-locally override any preferences that
+would auto-add them to files @code{.editorconfig} marks as
+trailing-newline-free
+@item
+@code{max_line_length}
+@item
+@code{file_type_emacs} (Experimental)
+@item
+@code{root} (only used by EditorConfig core)
+@end itemize
+
+Not yet covered properties marked with over-strike -- pull requests
+implementing missing features warmly welcomed! Typically, you will want
+to tie these to native functionality, or the configuration of existing
+packages handling the feature.
+
+As several packages have their own handling of, say, indention, we might
+not yet cover some mode you use, but we try to add the ones that show up
+on our radar. Similarly, we don't yet hook in to all different packages
+for whitespace trimming to inform them about editorconfig settings, but
+aim for better coverage of things like
+@uref{ftp://ftp.lysator.liu.se/pub/emacs/ws-trim.el,ws-trim}.
+
+This plugin also has an experimental support for @code{file_type_emacs},
+which specifies ``file types'' for files. As for Emacs, it means
+@code{major-mode} can be specified: for example, when
+@code{file_type_emacs} is set to @code{markdown} for @code{a.txt},
+@code{markdown-mode} will be enabled when opening @code{a.txt}. This
+property is experimental and its meaning might change in the future
+updates.
+
+@node Customize
+@section Customize
+@anchor{#customize}
+@menu
+* editorconfig-custom-hooks::
+* editorconfig-indentation-alist::
+* editorconfig-exec-path::
+* editorconfig-get-properties-function::
+@end menu
+
+@node editorconfig-custom-hooks
+@subsection @code{editorconfig-custom-hooks}
+@anchor{#editorconfig-custom-hooks}
+A list of custom hooks after loading common EditorConfig settings, where
+you can set some custom variables or overwrite existing properties.
+
+For example, @code{web-mode} has several variables for indentation
+offset size and EditorConfig sets them at once by @code{indent_size}.
+You may want to stop indenting only blocks of @code{web-mode}: it can be
+achieved by adding following to your init.el:
+
+@verbatim
+(add-hook 'editorconfig-custom-hooks
+ (lambda (hash) (setq web-mode-block-padding 0)))
+@end verbatim
+
+You can also define your own custom properties and enable them here.
+
+@node editorconfig-indentation-alist
+@subsection @code{editorconfig-indentation-alist}
+@anchor{#editorconfig-indentation-alist}
+Alist of indentation setting methods by modes.
+
+For the easiest case to add a new support for a major-mode, you just
+need to add a pair of major-mode symbol and its indentation variables:
+
+@verbatim
+(add-to-list 'editorconfig-indentation-alist
+ ;; Just an example, of course EditorConfig has already included this setting!
+ '(c-mode c-basic-offset))
+@end verbatim
+
+You can also modify this variable with the command M-x
+customize-variable [RET] editorconfig-indentation-alist [RET]. For a bit
+more complicated cases please take a look at the docstring of this
+variable.
+
+@node editorconfig-exec-path
+@subsection @code{editorconfig-exec-path}
+@anchor{#editorconfig-exec-path}
+String of @code{editorconfig} executable name (command name or full path
+to the executable).
+
+@node editorconfig-get-properties-function
+@subsection @code{editorconfig-get-properties-function}
+@anchor{#editorconfig-get-properties-function}
+Function to use to get EditorConfig properties.
+
+For example, if you always want to use built-in core library instead of
+any EditorConfig executable to get properties, add following to your
+init.el:
+
+@verbatim
+(set-variable 'editorconfig-get-properties-function
+ #'editorconfig-core-get-properties-hash)
+@end verbatim
+
+Possible known values are:
+
+@itemize
+@item
+@code{editorconfig-get-properties} (default)
+@itemize
+@item
+Use @code{editorconfig-get-properties-from-exec} when
+@code{editorconfig-exec-path} executable is found, otherwise use
+@code{editorconfig-core-get-properties-hash}
+@end itemize
+
+@item
+@code{editorconfig-get-properties-from-exec}
+@itemize
+@item
+Get properties by executing EditorConfig executable specified in
+@code{editorconfig-exec-path}
+@end itemize
+
+@item
+@code{editorconfig-core-get-properties-hash}
+@itemize
+@item
+Always use built-in Emacs-Lisp implementation to get properties
+@end itemize
+
+@end itemize
+
+@node Testing
+@section Testing
+@anchor{#testing}
+Make and @uref{https://cmake.org,CMake} must be installed to run the
+tests.
+
+To run the tests:
+
+@verbatim
+$ make test
+@end verbatim
+
+@node Submitting Bugs and Feature Requests
+@section Submitting Bugs and Feature Requests
+@anchor{#submitting-bugs-and-feature-requests}
+Bugs, feature requests, and other issues should be submitted to the
+issue tracker: https://github.com/editorconfig/editorconfig-emacs/issues
+
+@node License
+@section License
+@anchor{#license}
+EditorConfig Emacs Plugin is free software: you can redistribute it
+and/or modify it under the terms of the GNU General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
+Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program. If not, see @url{https://www.gnu.org/licenses/}.
+
+@bye
