From e8e00a0a57008a47ed3b8424bd43678f4dd56b14 Mon Sep 17 00:00:00 2001 From: Nicholas D Steeves Date: Fri, 27 Sep 2019 16:38:27 -0400 Subject: [PATCH 1/3] Update repology paragraph. Move definitions of what this method provides here. Use `apt` and not `apt-get`, because `apt` has been the recommended packaging interface since before Debian 9 (stretch), and calling `apt` on ancient systems will fail--I believe this is what we want, because a later paragraph says "PLEASE DO NOT INSTALL" ancient versions :-) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index eaa5d8f2..0a04b999 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ With GNU Emacs 24 or later then you can use its [package][] feature (or [Cask][] ### Install using OS package system -PHP Mode is available from [package systems provided by several OSs](https://repology.org/project/emacs:php-mode/versions). This is the easiest way to add PHP to Emacs and can be installed with just `sudo apt-get install elpa-php-mode`. +PHP Mode is available from [package systems provided by several OSs](https://repology.org/project/emacs:php-mode/versions). On Debian, and operating systems derived from it, such as Ubuntu, the easiest way to add PHP support to Emacs is `sudo apt install elpa-php-mode`. "Stable" releases of these operating systems include a well-tested frozen version of this package that is always older than the latest upstream version of PHP Mode. Autoloads and byte-compilation are automatic. The package name on Debian, Ubuntu, and some derived operating systems is [`elpa-php-mode`](https://packages.debian.org/buster/elpa-php-mode). The packages provided for these operating systems are stable, but since they are behind the latest version of PHP Mode, consider the possibility of not incorporating the latest PHP feature support and performance improvements. From 8759aac107c04bd0369b225dc2f1ee26c95fe2eb Mon Sep 17 00:00:00 2001 From: Nicholas D Steeves Date: Fri, 27 Sep 2019 16:43:24 -0400 Subject: [PATCH 2/3] Modify the second paragraph to show how to track latest dpkg version I find that "consider the possibility of not incorporating the latest PHP feature support and performance improvements" is unclear, and I believe that you wish to express the upstream desire to track recent versions, so here a solution. Of course users may always choose to track MELPA instead! --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a04b999..f6f7c183 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ With GNU Emacs 24 or later then you can use its [package][] feature (or [Cask][] PHP Mode is available from [package systems provided by several OSs](https://repology.org/project/emacs:php-mode/versions). On Debian, and operating systems derived from it, such as Ubuntu, the easiest way to add PHP support to Emacs is `sudo apt install elpa-php-mode`. "Stable" releases of these operating systems include a well-tested frozen version of this package that is always older than the latest upstream version of PHP Mode. Autoloads and byte-compilation are automatic. -The package name on Debian, Ubuntu, and some derived operating systems is [`elpa-php-mode`](https://packages.debian.org/buster/elpa-php-mode). The packages provided for these operating systems are stable, but since they are behind the latest version of PHP Mode, consider the possibility of not incorporating the latest PHP feature support and performance improvements. +Please consider installing the package provided in `sid` (aka: "unstable", a rolling release) in order to benefit from the latest PHP Mode features and performance improvements. The latest version can be found here: [`elpa-php-mode`](https://packages.debian.org/sid/elpa-php-mode). Investigate "apt-pinning" to make tracking this update stream automatic. Also, the `php-elisp` package provided by [Debian 9 (stretch)](https://packages.debian.org/stretch/php-elisp) and [Ubuntu 18.10](https://packages.ubuntu.com/cosmic/php-elisp) and earlier is [extremely old](https://github.com/emacs-php/php-mode/issues/430), so **PLEASE DO NOT INSTALL IT**. From 233715dcac462c5c2161908de56ae4428489fa5a Mon Sep 17 00:00:00 2001 From: Nicholas D Steeves Date: Fri, 27 Sep 2019 16:47:53 -0400 Subject: [PATCH 3/3] Add "Configuration" section for indentation style. I believe this tip (thanks to mallt) should have greater visibility. Please note the TODO item. I'm guessing a post-hook is what you'll choose to recommend. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index f6f7c183..759e97fe 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,10 @@ Load `php-mode` synchronously from a specific path. It will load 10 times the s (add-to-list 'load-path (expand-file-name "~/path/to/php-mode")) ``` +### Configuration + +PHP Mode's default style might not be what you expect. Before filing a bug, please try the following: `C-h v php-mode-coding-style`, to get the list of available styles. Then use `M-x php-set-style` for each of these, to check to see if one of them is to your liking. Use `TODO: Please comment on what config method you'd like to recommend to users` + Reporting Bugs --------------