From adf7ddb350bc2ae5edcbfaed17074182e5fca112 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Tue, 18 Jun 2024 21:17:21 +0200 Subject: [PATCH] minor fixes --- doc/man/editorconfig.texi | 35 ++++++++++++++++---------------- lisp/editorconfig-core-handle.el | 3 +-- lisp/editorconfig.el | 4 ++-- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/doc/man/editorconfig.texi b/doc/man/editorconfig.texi index 5e7d3b85552..98bc87743a5 100644 --- a/doc/man/editorconfig.texi +++ b/doc/man/editorconfig.texi @@ -1,10 +1,10 @@ @dircategory Emacs @direntry -* EditorConfig: (editorconfig). EditorConfig Emacs Plugin. +* EditorConfig: (editorconfig). EditorConfig Plugin. @end direntry @node Top -@chapter EditorConfig Emacs Plugin +@chapter EditorConfig Plugin @anchor{#editorconfig-emacs-plugin} This is an @uref{https://editorconfig.org,EditorConfig} plugin for @uref{https://www.gnu.org/software/emacs/,Emacs}. @@ -23,18 +23,19 @@ Getting Started @anchor{#getting-started} @menu -* packageel:: +* package:: * use-package:: * Manual installation:: @end menu -@node packageel +@node package @subsection package.el @anchor{#package.el} -This package is available from -@uref{https://melpa.org/#/editorconfig,MELPA}, -@uref{https://stable.melpa.org/#/editorconfig,MELPA Stable} and + +This package is shipped with Emacs. More recent versions can be +installed from @uref{http://elpa.nongnu.org/nongnu/editorconfig.html,NonGNU ELPA}. + Install from these repositories and enable global minor-mode @code{editorconfig-mode}: @@ -43,7 +44,7 @@ packageel @end verbatim Normally, enabling @code{editorconfig-mode} should be enough for this -plugin to work: all other configurations are optional. This mode sets up +plugin to work: all other configurations are optional. This mode sets up hooks so that EditorConfig properties will be loaded and applied to the new buffers automatically when visiting files. @@ -129,7 +130,7 @@ File Type file_type_ext file_type_emacs @subsection File Type (file_type_ext, file_type_emacs) @anchor{#file-type-file_type_ext-file_type_emacs} File-type feature is currently disabled, because this package is now -undergoing big internal refactoring. For those who want this +undergoing big internal refactoring. For those who want this functionality, please consider using @uref{https://github.com/10sr/editorconfig-custom-majormode-el,editorconfig-custom-majormode}. @@ -159,7 +160,7 @@ editorconfig-trim-whitespaces-mode One possible value is @uref{https://github.com/lewang/ws-butler,@code{ws-butler-mode}}, with -which only lines touched get trimmed. To use it, add following to your +which only lines touched get trimmed. To use it, add following to your init.el: @verbatim @@ -215,7 +216,7 @@ Troubleshooting @code{M-x editorconfig-display-current-properties}. This command will open a new buffer and display the EditorConfig -properties loaded for current buffer. You can check if EditorConfig +properties loaded for current buffer. You can check if EditorConfig properties were not read for buffers at all, or they were loaded but did not take effect for some other reasons. @@ -232,8 +233,8 @@ Indentation for new major-modes @code{indent_size} property. By default this plugin ships with settings for many major-modes, but, -sorry to say, it cannot be perfect. Especially it is difficult to -support brand-new major-modes. Please feel free to submit issue or +sorry to say, it cannot be perfect. Especially it is difficult to +support brand-new major-modes. Please feel free to submit issue or pull-request for such major-mode! Supported major-modes and their indentation configs are defined in the @@ -243,13 +244,13 @@ Not work at all for FOO-mode! @subsection Not work at all for FOO-mode! @anchor{#not-work-at-all-for-foo-mode} Most cases properties are loaded just after visiting files when -@code{editorconfig-mode} is enabled. But it is known that there are +@code{editorconfig-mode} is enabled. But it is known that there are major-modes that this mechanism does not work for and require explicit call of @code{editorconfig-apply}. Typically it will occur when the major-mode is not defined using @code{define-derived-mode} (@code{rpm-spec-mode} is an example for -this). Please feel free to submit issues if you find such modes! +this). Please feel free to submit issues if you find such modes! @node Submitting Bugs and Feature Requests @section Submitting Bugs and Feature Requests @@ -288,10 +289,10 @@ License 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 +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/}. +with this program. If not, see @url{https://www.gnu.org/licenses/}. @bye diff --git a/lisp/editorconfig-core-handle.el b/lisp/editorconfig-core-handle.el index d225e1456ba..c24afa11455 100644 --- a/lisp/editorconfig-core-handle.el +++ b/lisp/editorconfig-core-handle.el @@ -74,8 +74,7 @@ editorconfig-core-handle Last modified time of .editorconfig file. `path' - Absolute path to .editorconfig file.' -" + Absolute path to .editorconfig file." (top-props nil) (sections nil) (mtime nil) diff --git a/lisp/editorconfig.el b/lisp/editorconfig.el index 8c34f94093c..a7e34434258 100644 --- a/lisp/editorconfig.el +++ b/lisp/editorconfig.el @@ -1,4 +1,4 @@ -;;; editorconfig.el --- EditorConfig Emacs Plugin -*- lexical-binding: t -*- +;;; editorconfig.el --- EditorConfig Plugin -*- lexical-binding: t -*- ;; Copyright (C) 2011-2024 EditorConfig Team @@ -182,7 +182,7 @@ editorconfig-indentation-alist (web-mode . editorconfig--get-indentation-web-mode) (zig-mode zig-indent-offset) ) - "Alist of indentation setting methods by modes + "Alist of indentation setting methods by modes. This is a fallback used for those modes which don't set `editorconfig-indent-size-vars'. -- 2.45.2