[elpa] externals/bnf-mode 4bc5d15 17/22: Move documentation to the project root

[Stefan Monnier]

branch: externals/bnf-mode
commit 4bc5d15f7223ffe52747415f04318d1a197b1577
Author: Serghei Iakovlev <address@hidden>
Commit: Serghei Iakovlev <address@hidden>

    Move documentation to the project root
---
 .elpaignore                         |  14 +-
 .gitignore                          |  23 ++-
 Makefile                            |  33 ++--
 bnf-mode.info                       | 377 ++++++++++++++++++++++++++++++++++++
 docs/bnf-mode.texi => bnf-mode.texi |   0
 default.mk                          |   6 +
 docs/Makefile                       |  37 ----
 7 files changed, 435 insertions(+), 55 deletions(-)

diff --git a/.elpaignore b/.elpaignore
index ca37d8b..5e1a05c 100644
--- a/.elpaignore
+++ b/.elpaignore
@@ -1,6 +1,18 @@
-.github
+*.elc
+*.tar
+.cask
+.codecov.yml
+.dir-locals.el
+.elpaignore
 .ert-runner
+.git
+.github
+.gitignore
 .gitignore
+Cask
+GPATH
+GRTAGS
+GTAGS
 Makefile
 default.mk
 test
diff --git a/.gitignore b/.gitignore
index a59fd18..c6a55bf 100644
--- a/.gitignore
+++ b/.gitignore
@@ -7,11 +7,30 @@
 
 *~
 *.elc
+
+# Directories to ignore (do not add trailing '/'s, they skip symlinks).
 .cask
-bnf-mode.info
+
+# Documentation artefacts.
+*.aux
+*.cp
+*.cps
+*.epub
+*.html
+*.pdf
+*.toc
+*.vr
+*.vrs
+
+# Build artefacts.
 bnf-mode-pkg.el
 bnf-mode-autoloads.el
 bnf-mode-*.tar
-coverage-final.json
 ChangeLog
 README
+
+# Code coverage report.
+coverage-final.json
+
+# Use this as your own wish list or a temporary buffer.
+LATER
diff --git a/Makefile b/Makefile
index fe635e7..5e95d6c 100644
--- a/Makefile
+++ b/Makefile
@@ -19,9 +19,18 @@ include default.mk
 
 .DEFAULT_GOAL = build
 
+%.info: %.texi
+       $(info Generating $@)
+       @$(MAKEINFO) --no-split $< -o $@
+
 %.elc: %.el
        @printf "Compiling $<\n"
-       @$(RUNEMACS) --eval '(setq byte-compile-error-on-warn t)' -f 
batch-byte-compile $<
+       @$(RUNEMACS) --eval '(setq byte-compile-error-on-warn t)' \
+               -f batch-byte-compile $<
+
+dir: $(INFOPAGES)
+       $(info Generating dir)
+       @echo $^ | xargs -n 1 $(INSTALL_INFO) --dir=$@
 
 # Remove badges
 define org-clean
@@ -29,7 +38,8 @@ define org-clean
 endef
 
 README: README.org
-       $(call org-clean,$^) | $(PANDOC) $(PANDOCLAGS) -t plain | sed -e 
"s/\[\]//g" > $@
+       $(call org-clean,$^) | \
+               $(PANDOC) $(PANDOCLAGS) -t plain | sed -e "s/\[\]//g" > $@
 
 ChangeLog: NEWS
        @cp $^ $@
@@ -37,10 +47,9 @@ ChangeLog: NEWS
 $(PACKAGE)-pkg.el: $(PACKAGE).el
        @$(CASK) pkg-file
 
-$(ARCHIVE_NAME).tar: README ChangeLog LICENSE $(PACKAGE).el $(PACKAGE)-pkg.el
-       @$(MAKE) info
-       @$(TAR) -c -v -f $(ARCHIVE_NAME).tar --transform 
"s@^@$(ARCHIVE_NAME)/@" $^
-       @cd docs && $(TAR) -r -f ../$(ARCHIVE_NAME).tar --transform 
"s@^@$(ARCHIVE_NAME)/@" $(PACKAGE).info dir
+$(ARCHIVE_NAME).tar: $(ARCHIVE_CONTENTS)
+       @$(TAR) -c -v -f $(ARCHIVE_NAME).tar \
+               --transform "s@^@$(ARCHIVE_NAME)/@" $^
 
 ## Public targets
 
@@ -64,17 +73,13 @@ test:
        @$(CASK) exec ert-runner $(TESTFLAGS)
 
 .PHONY: clean
-clean: clean-docs
+clean:
        $(info Remove all byte compiled Elisp files...)
        @$(CASK) clean-elc
        $(info Remove build artefacts...)
-       @$(RM) README ChangeLog $(PACKAGE).info coverage-final.json
+       @$(RM) README ChangeLog coverage-final.json
        @$(RM) $(PACKAGE)-pkg.el $(PACKAGE)-*.tar
 
-.PHONY: clean-docs
-clean-docs:
-       @$(MAKE) -C docs clean
-
 .PHONY: package
 package: $(ARCHIVE_NAME).tar
 
@@ -84,8 +89,7 @@ install: $(ARCHIVE_NAME).tar
                "(let ((debug-on-error t))(package-install-file 
\"$(PWD)/$(ARCHIVE_NAME).tar\"))"
 
 .PHONY: info
-info:
-       @$(MAKE) -C docs info
+info: $(INFOPAGES) dir
 
 .PHONY: help
 help: .title
@@ -101,7 +105,6 @@ help: .title
        @echo '  test:       Run the non-interactive unit test suite'
        @echo '  clean:      Remove all byte compiled Elisp files, 
documentation,'
        @echo '              build artefacts and tarball'
-       @echo '  clean-docs: Remove all ganerated documentation'
        @echo '  package:    Build package'
        @echo '  install:    Install BNF Mode'
        @echo '  info:       Generate info manual'
diff --git a/bnf-mode.info b/bnf-mode.info
new file mode 100644
index 0000000..bab6b4e
--- /dev/null
+++ b/bnf-mode.info
@@ -0,0 +1,377 @@
+This is bnf-mode.info, produced by makeinfo version 6.5 from
+bnf-mode.texi.
+
+     Copyright © 2019, 2020 Free Software Foundation, Inc.
+
+     You can redistribute this document 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 document 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.
+INFO-DIR-SECTION Emacs
+START-INFO-DIR-ENTRY
+* BNF Mode: (bnf-mode).         Major mode for editing BNF grammars.
+END-INFO-DIR-ENTRY
+
+
+File: bnf-mode.info,  Node: Top,  Next: Introduction,  Up: (dir)
+
+BNF Mode User Manual
+********************
+
+BNF Mode is a GNU Emacs major mode for editing BNF grammars.  Currently
+this mode provides basic syntax and font-locking for BNF files.  BNF
+notation is supported exactly form as it was first announced in the
+ALGOL 60 report.
+
+This manual is for BNF Mode version 0.4.4.
+
+     Copyright © 2019, 2020 Free Software Foundation, Inc.
+
+     You can redistribute this document 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 document 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.
+
+* Menu:
+
+* Introduction::     The mode description and concepts.
+* Installation::     The ways of instalation BNF Mode.
+* Usage::            BNF Mode usage.
+* Customizing::      Customizing BNF Mode.
+* Project Links::    Some important project links.
+* Bibliography::     External resources used in the project.
+* Index::            Complete index.
+* Variable Index::   Variable index.
+
+— The Detailed Node Listing —
+
+Installation
+
+* Installing from Elpa or Melpa::
+* Installing using El-get::
+* Installing from the Git Repository::
+
+
+Project Links
+
+* Bugs Tracker::
+* Change Log::
+
+
+
+File: bnf-mode.info,  Node: Introduction,  Next: Installation,  Prev: Top,  
Up: Top
+
+1 Introduction
+**************
+
+BNF Mode is a GNU Emacs major mode for editing BNF grammars.  Currently
+this mode provides basic syntax and font-locking for BNF files.  BNF
+notation is supported exactly form as it was first announced in the
+ALGOL 60 report.
+
+
+File: bnf-mode.info,  Node: Installation,  Next: Usage,  Prev: Introduction,  
Up: Top
+
+2 Installation
+**************
+
+BNF Mode known to work with GNU Emacs 24.3 and later.  BNF Mode may work
+with older versions of Emacs, or with other flavors of Emacs (e.g.
+XEmacs) but this is not guaranteed.  Bug reports for problems related to
+using BNF Mode with older versions of Emacs will most like not be
+addressed.
+
+* Menu:
+
+* Installing from Elpa or Melpa::
+* Installing using El-get::
+* Installing from the Git Repository::
+
+
+File: bnf-mode.info,  Node: Installing from Elpa or Melpa,  Next: Installing 
using El-get,  Up: Installation
+
+2.1 Installing from Elpa or Melpa
+=================================
+
+BNF Mode is available from Elpa, Melpa and Melpa-Stable.  If you haven’t
+used Emacs’ package manager before, then it is high time you familiarize
+yourself with it by reading the documentation in the Emacs manual, see
+*note (emacs)Packages::.  Then add one of the archives to
+‘package-archives’:
+
+   • To use Elpa:
+
+     (require 'package)
+     (add-to-list 'package-archives
+                  '("gnu" . "https://elpa.gnu.org/packages/";) t)
+     (package-initialize)
+
+   • For those who want only formal, tagged releases use Melpa Stable:
+
+     (require 'package)
+     (add-to-list 'package-archives
+                  '("melpa-stable" . "http://stable.melpa.org/packages/";) t)
+     (package-initialize)
+
+   • For those who want rolling releases as they happen use Melpa:
+
+     (require 'package)
+     (add-to-list 'package-archives
+                  '("melpa" . "http://melpa.org/packages/";) t)
+     (package-initialize)
+
+   Melpa tracks BNF Mode’s Git repository and updates relatively soon
+after each commit or formal release.  For more detail on setting up see
+MELPA Getting Started (https://melpa.org/#/getting-started).
+
+   Once you have added your preferred archive, you need to update the
+local package list using ‘M-x’ ‘package-refresh-contents’ ‘RET’.
+Finally, use ‘M-x’ ‘package-list-packages’ ‘RET’ to get to the package
+listing and install ‘bnf-mode’ from there.
+
+   There are several ways to install ‘bnf-mode’ after package
+initialization:
+
+   • You can install ‘bnf-mode’ manually by adding following to your
+     init file:
+
+     (unless (package-installed-p 'bnf-mode)
+         (package-refresh-contents)
+         (package-install 'bnf-mode))
+
+   • To use Cask (https://cask.github.io/) add following to your ‘Cask’
+     file:
+
+     (source melpa)
+     (depends-on "bnf-mode")
+
+   • To install ‘bnf-mode’ using ‘use-package’ add following to your
+     init file:
+
+     (use-package bnf-mode
+       :ensure t
+       ;; To use MELPA Stable use ":pin mepla-stable",
+       ;; to use ELPA remove ":pin" line
+       :pin melpa
+       :mode "\\.bnf\\'")
+
+
+File: bnf-mode.info,  Node: Installing using El-get,  Next: Installing from 
the Git Repository,  Prev: Installing from Elpa or Melpa,  Up: Installation
+
+2.2 Installing using El-get
+===========================
+
+If you use el-get, just create a recipe file ‘bnf.rcp’:
+
+     (:name bnf-mode
+      :website "https://github.com/sergeyklay/bnf-mode";
+      :description "BNF Mode: A major mode for editing BNF grammars"
+      :type github
+      :pkgname "sergeyklay/bnf-mode")
+
+   Then add it to a directory present in ‘el-get-recipe-path’.  Then,
+use ‘M-x’ ‘el-get-install’ ‘RET’ ‘bnf-mode’ ‘RET’ or add to your init
+file:
+
+     (el-get-bundle bnf-mode)
+
+
+File: bnf-mode.info,  Node: Installing from the Git Repository,  Prev: 
Installing using El-get,  Up: Installation
+
+2.3 Installing from the Git Repository
+======================================
+
+BNF Mode depends only on the ‘cl-lib’, which is bundled with GNU Emacs.
+Thus you don’t have to install any additional library to satisfy BNF
+Mode dependencies.  Below are simple steps to install BNF Mode using
+manual approach:
+
+   Clone the BNF Mode repository:
+
+     $ git clone https://github.com/sergeyklay/bnf-mode.git \
+       ~/.emacs.d/site-lisp/bnf-mode
+
+   Add this to your init file:
+
+     (add-to-list 'load-path "~/.emacs.d/site-lisp/bnf-mode")
+
+   Add either of the two following lines to your initialization file.
+The first only loads BNF Mode when necessary, the 2nd always during
+startup of GNU Emacs:
+
+     (autoload 'bnf-mode "bnf-mode" nil t)
+     ;; OR
+     (require 'bnf-mode)
+
+
+File: bnf-mode.info,  Node: Usage,  Next: Customizing,  Prev: Installation,  
Up: Top
+
+3 Usage
+*******
+
+By default any file that matches the glob ‘*.bnf’ is automatically
+opened in ‘bnf-mode’.  To toggle the mode in the current buffer use
+‘M-x’ ‘bnf-mode’ ‘RET’.
+
+
+File: bnf-mode.info,  Node: Customizing,  Next: Project Links,  Prev: Usage,  
Up: Top
+
+4 Customizing
+*************
+
+There are not so much BNF Mode customize options yet.  The most
+interested option is ‘bnf-mode-algol-comments-style’.  Setting it to
+non-nill means use for BNF comments style introduced in ALGOL 60.  The
+following "comment" conventions will hold:
+
+The sequence of basic symbols                      Is equivalent to
+--------------------------------------------------------------------------
+‘; comment <any sequence not containing ;>;’       ‘;’
+‘begin comment <any sequence not containing ;>;’   ‘begin’
+
+
+   Enabling this feature will disable comments recognition which use
+semicolon only (‘;’).
+
+
+   To customize BNF Mode options, use command as follows:
+
+     M-x customize-group bnf RET
+
+
+File: bnf-mode.info,  Node: Project Links,  Next: Bibliography,  Prev: 
Customizing,  Up: Top
+
+5 Project Links
+***************
+
+* Menu:
+
+* Bugs Tracker::
+* Change Log::
+
+
+File: bnf-mode.info,  Node: Bugs Tracker,  Next: Change Log,  Up: Project Links
+
+5.1 Bugs Tracker
+================
+
+Bug tracking is currently handled using the GitHub issue tracker
+(https://github.com/sergeyklay/bnf-mode/issues).
+
+
+File: bnf-mode.info,  Node: Change Log,  Prev: Bugs Tracker,  Up: Project Links
+
+5.2 Change Log
+==============
+
+History is tracked in the Git repository
+(https://github.com/sergeyklay/bnf-mode/blob/master/NEWS) rather than in
+this documentation.
+
+
+File: bnf-mode.info,  Node: Bibliography,  Next: Index,  Prev: Project Links,  
Up: Top
+
+6 Bibliography
+**************
+
+Below are some links to external resources used when developed BNF Mode:
+
+   • RFC822: Standard for ARPA Internet Text Messages.
+
+     <https://www.ietf.org/rfc/rfc822.txt>
+
+   • RFC5234: Augmented BNF for Syntax Specifications ABNF.
+
+     <https://www.ietf.org/rfc/rfc5234.txt>
+
+   • RFC7405: Case-Sensitive String Support in ABNF.
+
+     <https://www.ietf.org/rfc/rfc7405.txt>
+
+   • Revised Report on the Algorithmic Language Algol 60.
+
+     <https://www.masswerk.at/algol60/report.htm>
+
+   • Wikipedia: Backus–Naur form.
+
+     <https://en.wikipedia.org/wiki/Backus%E2%80%93Naur_form>
+
+   • Wikipedia: Extended Backus–Naur form.
+
+     <https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form>
+
+   • Wikipedia: Augmented Backus–Naur form.
+
+     <https://en.wikipedia.org/wiki/Augmented_Backus%E2%80%93Naur_form>
+
+   • ISO/IEC 14977: 1996(E).
+
+     <https://www.cl.cam.ac.uk/~mgk25/iso-14977.pdf>
+
+   • EBNF: A Notation to Describe Syntax.
+
+     <https://www.ics.uci.edu/~pattis/ICS-33/lectures/ebnf.pdf>
+
+
+File: bnf-mode.info,  Node: Index,  Next: Variable Index,  Prev: Bibliography, 
 Up: Top
+
+Index
+*****
+
+[index]
+* Menu:
+
+* Cask, installation:                    Installing from Elpa or Melpa.
+                                                               (line 52)
+* Customizing:                           Customizing.          (line  6)
+* Elpa, installation:                    Installing from Elpa or Melpa.
+                                                               (line 12)
+* Installation:                          Installation.         (line  6)
+* Melpa, installation:                   Installing from Elpa or Melpa.
+                                                               (line 19)
+
+
+File: bnf-mode.info,  Node: Variable Index,  Prev: Index,  Up: Top
+
+Variable Index
+**************
+
+[index]
+* Menu:
+
+* bnf-mode-algol-comments-style:         Customizing.           (line 6)
+
+
+
+Tag Table:
+Node: Top767
+Node: Introduction2295
+Node: Installation2640
+Node: Installing from Elpa or Melpa3162
+Node: Installing using El-get5478
+Node: Installing from the Git Repository6157
+Node: Usage7058
+Node: Customizing7343
+Node: Project Links8178
+Node: Bugs Tracker8349
+Node: Change Log8582
+Node: Bibliography8831
+Node: Index9989
+Node: Variable Index10696
+
+End Tag Table
+
+
+Local Variables:
+coding: utf-8
+End:
diff --git a/docs/bnf-mode.texi b/bnf-mode.texi
similarity index 100%
rename from docs/bnf-mode.texi
rename to bnf-mode.texi
diff --git a/default.mk b/default.mk
index e48a3ba..f7bf1ee 100644
--- a/default.mk
+++ b/default.mk
@@ -52,3 +52,9 @@ SRCS = bnf-mode.el
 OBJS = $(SRCS:.el=.elc)
 
 INFOPAGES = $(addsuffix .info,$(PACKAGE))
+ARCHIVE_CONTENTS = README \
+       ChangeLog \
+       LICENSE \
+       $(PACKAGE).el \
+       $(PACKAGE)-pkg.el \
+       $(INFOPAGES) dir
diff --git a/docs/Makefile b/docs/Makefile
deleted file mode 100644
index 12c7afc..0000000
--- a/docs/Makefile
+++ /dev/null
@@ -1,37 +0,0 @@
-# Copyright (C) 2019, 2020 Free Software Foundation, Inc.
-#
-# License
-#
-# This file 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 file 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 file.  If not, see <https://www.gnu.org/licenses/>.
-
-include ../default.mk
-
-.PHONY: all
-all: info
-
-.PHONY: info
-info: $(INFOPAGES) dir
-
-%.info: %.texi
-       $(info Generating $@)
-       @$(MAKEINFO) --no-split $< -o $@
-
-dir: $(INFOPAGES)
-       $(info Generating dir)
-       @echo $^ | xargs -n 1 $(INSTALL_INFO) --dir=$@
-
-.PHONY: clean
-clean:
-       $(info Cleaning documentation...)
-       @$(RM) dir $(INFOPAGES)