branch: externals/bnf-mode commit a1f2a93246642f14bd05479e5369a195f88ab4ae Merge: e83db96 2f217ec Author: Stefan Monnier <monn...@iro.umontreal.ca> Commit: Stefan Monnier <monn...@iro.umontreal.ca>
Merge remote-tracking branch 'bnf-mode/master' into externals/bnf-mode --- CHANGELOG.org | 6 ++--- README.org | 59 +++++++++++++++++++++++++++++++++------------- bnf-mode.el | 6 ++--- test/bnf-mode-font-test.el | 4 ++-- test/test-helper.el | 4 ++-- 5 files changed, 50 insertions(+), 29 deletions(-) diff --git a/CHANGELOG.org b/CHANGELOG.org index d886c8b..ac2ecba 100644 --- a/CHANGELOG.org +++ b/CHANGELOG.org @@ -5,7 +5,8 @@ All notable changes to this project will be documented in this file. The format is based on [[http://keepachangelog.com][Keep a Changelog]] and this project adheres to [[http://semver.org][Semantic Versioning]]. -** [[https://github.com/sergeyklay/bnf-mode/compare/0.4.1...HEAD][Unreleased]] +** [[https://github.com/sergeyklay/bnf-mode/compare/0.4.2...HEAD][Unreleased]] +** [[https://github.com/sergeyklay/bnf-mode/compare/0.4.1...0.4.2][0.4.2]] - 2019-05-14 *** Added - Introduced ALGOL 60 comments style. Disabled by default. For more see: [[https://github.com/sergeyklay/bnf-mode/pull/4][#4]] . @@ -14,9 +15,6 @@ The format is based on [[http://keepachangelog.com][Keep a Changelog]] and this - Only setting =bnf-mode-algol-comments-style= to non-nil will allow use semicolons as a regular terminal symbols. For more see: [[https://github.com/sergeyklay/bnf-mode/pull/4][#4]] . -** Removed -- Removed wrongly used (and documented) =syntax-propertize-function= funcall - ** [[https://github.com/sergeyklay/bnf-mode/compare/0.4.0...0.4.1][0.4.1]] - 2019-04-21 *** Fixes - Minor fix related to build & deploy BNF Mode on Travis CI. diff --git a/README.org b/README.org index 08e26c2..83d85b9 100644 --- a/README.org +++ b/README.org @@ -43,12 +43,30 @@ NOTE: The ~master~ branch will always contain the latest unstable version. If you wish to check older versions or formal, tagged release, please switch to the relevant [[https://github.com/sergeyklay/bnf-mode/tags][tag]]. -*** Using MELPA - The best way of installing this major mode, at least for GNU Emacs 24, is to -use the packaging system. Add MELPA or MELPA Stable to the list of repositories -to access this mode. For those who want only formal, tagged releases use MELPA -Stable: +use the packaging system. The following are ways to install using ELPA and +MELPA. + +*** Using ELPA or MELPA +**** ELPA + +Since version 0.4.1 BNF Mode is available for installation from ELPA. +Add ELPA to the list of repositories to access this mode: + +#+begin_src emacs-lisp +(require 'package) +(add-to-list 'package-archives + '("gnu" . "https://elpa.gnu.org/packages/") t) +(package-initialize) +#+end_src + +**** MELPA + +Add MELPA or MELPA Stable to the list of repositories to access this mode. +MELPA tracks this Git repository and updates relatively soon after each commit +or formal release. For more detail on setting up see [[https://melpa.org/#/getting-started][MELPA Getting Started]]. + +For those who want only formal, tagged releases use MELPA Stable: #+begin_src emacs-lisp (require 'package) @@ -66,10 +84,14 @@ For those who want rolling releases as they happen use MELPA: (package-initialize) #+end_src -and then use ~M-x package-refresh-contents~ and ~M-x package-list-packages~ to get to -the package listing and install ~bnf-mode~ from there. MELPA tracks this Git repository -and updates relatively soon after each commit or formal release. For more detail on -setting up see [[https://melpa.org/#/getting-started][MELPA Getting Started]]. +After initializing packaging system you can install BNF Mode using preferred way: + +***** =package-list-packages= + +Use ~M-x package-refresh-contents~ and ~M-x package-list-packages~ to get to +the package listing and install ~bnf-mode~ from there. + +***** Manual You can install ~bnf-mode~ manually by adding following to your init file: @@ -79,7 +101,7 @@ You can install ~bnf-mode~ manually by adding following to your init file: (package-install 'bnf-mode)) #+end_src -**** Using Cask +***** Cask Add following to your [[https://cask.github.io/][Cask]] file: @@ -89,27 +111,29 @@ Add following to your [[https://cask.github.io/][Cask]] file: (depends-on "bnf-mode") #+end_src -**** Using use-package +***** =use-package= Add following to your init file: #+begin_src emacs-lisp (use-package bnf-mode :ensure t + ;; To use MELPA Stable use ":pin mepla-stable", + ;; to use ELPA remove ":pin" line + :pin melpa :mode "\\.bnf\\'") #+end_src *** El-get - If you use el-get, just create a recipe file ~bnf.rcp~: #+begin_src emacs-lisp (: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") + :website "https://github.com/sergeyklay/bnf-mode" + :description "BNF Mode: A major mode for editing BNF grammars" + :type github + :pkgname "sergeyklay/bnf-mode") #+end_src and add it to a directory present in ~el-get-recipe-path~. @@ -168,4 +192,5 @@ To see what has changed in recent versions of BNF Mode, see the [[https://github ** License -BNF Mode is open source software licensed under the [[https://github.com/sergeyklay/bnf-mode/blob/master/LICENSE][GNU General Public Licence version 3]] . +BNF Mode is open source software licensed under the [[https://github.com/sergeyklay/bnf-mode/blob/master/LICENSE][GNU General Public Licence version 3]]. +Copyright © 2019, Free Software Foundation, Inc. diff --git a/bnf-mode.el b/bnf-mode.el index 95a3ccc..f4f83ab 100644 --- a/bnf-mode.el +++ b/bnf-mode.el @@ -4,7 +4,7 @@ ;; Author: Serghei Iakovlev <sadhook...@gmail.com> ;; Maintainer: Serghei Iakovlev <sadhook...@gmail.com> -;; Version: 0.4.1 +;; Version: 0.4.2 ;; URL: https://github.com/sergeyklay/bnf-mode ;; Keywords: languages ;; Package-Requires: ((cl-lib "0.5") (emacs "24.3")) @@ -62,8 +62,6 @@ (eval-when-compile (require 'rx)) ; `rx' -;; (require 'cl-lib) ; `cl-defmacro' - ;;; Customization @@ -101,7 +99,7 @@ semicolon only (\";\")." `((bnf-rule-name . ,(rx (and (1+ (or alnum digit)) (0+ (or alnum digit - (in "!\"#$%&'()*+,-./:;=?@[\\]^_`{|}~") + (in "!\"#$%&'()*+,-./:;=?@[]^_`{|}~") (in " \t")))))) "Additional special sexps for `bnf-rx'.")) diff --git a/test/bnf-mode-font-test.el b/test/bnf-mode-font-test.el index b2d01c6..e88a6fc 100644 --- a/test/bnf-mode-font-test.el +++ b/test/bnf-mode-font-test.el @@ -3,8 +3,8 @@ ;; Copyright (C) 2019 Free Software Foundation, Inc. ;; Author: Serghei Iakovlev <sadhook...@gmail.com> -;; Maintainer: Serghei Iakovlev -;; Version: 0.4.1 +;; Maintainer: Serghei Iakovlev <sadhook...@gmail.com> +;; Version: 0.4.2 ;; URL: https://github.com/sergeyklay/bnf-mode ;; This file is NOT part of GNU Emacs. diff --git a/test/test-helper.el b/test/test-helper.el index b38e051..379608b 100644 --- a/test/test-helper.el +++ b/test/test-helper.el @@ -3,8 +3,8 @@ ;; Copyright (C) 2019 Free Software Foundation, Inc ;; Author: Serghei Iakovlev <sadhook...@gmail.com> -;; Maintainer: Serghei Iakovlev -;; Version: 0.4.1 +;; Maintainer: Serghei Iakovlev <sadhook...@gmail.com> +;; Version: 0.4.2 ;; URL: https://github.com/sergeyklay/bnf-mode ;; This file is NOT part of GNU Emacs.