From 4885473a6d248a6ee508b7b7ef3705762af631d9 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Sat, 2 Dec 2023 10:23:26 +0000 Subject: [PATCH] Generate info documentation --- rgel.info | 165 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 103 insertions(+), 62 deletions(-) diff --git a/rgel.info b/rgel.info index 62d1607..6992df8 100644 --- a/rgel.info +++ b/rgel.info @@ -1,6 +1,6 @@ This is rgel.info, produced by makeinfo version 6.8 from rgel.texi. - rg.el 2.3.0, Apr 30, 2023 + rg.el 2.3.0, Dec 02, 2023 David Landell @@ -20,7 +20,7 @@ File: rgel.info, Node: Top, Next: Usage, Up: (dir) RG User Manual ************** - rg.el 2.3.0, Apr 30, 2023 + rg.el 2.3.0, Dec 02, 2023 David Landell @@ -1231,11 +1231,12 @@ report it in the issue tracker (https://github.com/dajva/rg.el/issues). * Menu: * Pull requests:: +* Docker:: * Tests:: * Documentation::  -File: rgel.info, Node: Pull requests, Next: Tests, Up: Contribute +File: rgel.info, Node: Pull requests, Next: Docker, Up: Contribute 3.1 Pull requests ================= @@ -1256,15 +1257,50 @@ new code in order to discuss the best way to proceed and what additions are needed.  -File: rgel.info, Node: Tests, Next: Documentation, Prev: Pull requests, Up: Contribute +File: rgel.info, Node: Docker, Next: Tests, Prev: Pull requests, Up: Contribute -3.2 Tests +3.2 Docker +========== + +Docker can be used to run the tests or generate documentation locally +without installing dependencies on the host and to test with different +emacs versions. + +To use docker, just set the ‘USE_DOCKER’ variable when running the +tests. The ‘EMACS_VERSION’ variable can be used to select emacs +version. Note that dash (‘-’) is used instead of points (‘.’) in the +version numbering. So emacs 28.2 is specified as ‘28-2’. Emacs are +installed from ‘https://github.com/purcell/nix-emacs-ci’ so only emacs +versions supported in that repository will work. + + - Build docker container: + + # Don't use the USE_DOCKER variable here + make EMACS_VERSION=26-2 docker-build + + - To run all the tests in docker image: + + make USE_DOCKER=true test + + - Use a specific emacs version: + + make USE_DOCKER=true EMACS_VERSION=snapshot + + - Generate html documentation: + + make USE_DOCKER=true html + + +File: rgel.info, Node: Tests, Next: Documentation, Prev: Docker, Up: Contribute + +3.3 Tests ========= Cask (https://cask.readthedocs.io/) is used for testing. The tests are -written using the Emacs built in ERT framework and executed with ert -runner (https://github.com/rejeep/ert-runner.el). There are also -compilation tests, style check, package verification etc. +written using the Emacs built in ERT framework and follows the +conventions of ert runner (https://github.com/rejeep/ert-runner.el) +although ert_runner is no longer used. There are also compilation +tests, style check, package verification etc. * Menu: @@ -1274,7 +1310,7 @@ compilation tests, style check, package verification etc.  File: rgel.info, Node: Setup, Next: Running, Up: Tests -3.2.1 Setup +3.3.1 Setup ----------- - Install cask @@ -1287,7 +1323,7 @@ File: rgel.info, Node: Setup, Next: Running, Up: Tests  File: rgel.info, Node: Running, Prev: Setup, Up: Tests -3.2.2 Running +3.3.2 Running ------------- - Run the whole test suite: @@ -1305,7 +1341,7 @@ File: rgel.info, Node: Running, Prev: Setup, Up: Tests  File: rgel.info, Node: Documentation, Prev: Tests, Up: Contribute -3.3 Documentation +3.4 Documentation ================= The documentation is written in org mode. The export target is @@ -1329,7 +1365,7 @@ expected.  File: rgel.info, Node: Setup<2>, Next: Building, Up: Documentation -3.3.1 Setup +3.4.1 Setup ----------- - Install Sphinx @@ -1344,7 +1380,7 @@ File: rgel.info, Node: Setup<2>, Next: Building, Up: Documentation  File: rgel.info, Node: Building, Prev: Setup<2>, Up: Documentation -3.3.2 Building +3.4.2 Building -------------- - HTML documentation @@ -1377,7 +1413,7 @@ option) any later version. `rg' 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 *note GNU General Public -License: 92. for more details. +License: 94. for more details. * Menu: @@ -2459,54 +2495,59 @@ Ref: contribute doc43536 Ref: 8043536 Ref: contribute contribute43536 Ref: 8143536 -Node: Pull requests43831 -Ref: contribute id143903 -Ref: 8243903 -Ref: contribute pull-requests43903 -Ref: 8343903 -Node: Tests44709 -Ref: contribute id244803 -Ref: 8444803 -Ref: contribute tests44803 -Ref: 8544803 -Node: Setup45122 -Ref: contribute setup45183 -Ref: 8645183 -Ref: contribute tests-setup45183 -Ref: 8745183 -Node: Running45359 -Ref: contribute running45420 -Ref: 8845420 -Ref: contribute tests-running45420 -Ref: 8945420 -Node: Documentation45701 -Ref: contribute documentation45773 -Ref: 8a45773 -Ref: contribute id345773 -Ref: 8b45773 -Node: Setup<2>46493 -Ref: contribute documentation-setup46566 -Ref: 8c46566 -Ref: contribute id446566 -Ref: 8d46566 -Node: Building46806 -Ref: contribute building46879 -Ref: 8e46879 -Ref: contribute documentation-building46879 -Ref: 8f46879 -Node: License47184 -Ref: index id147262 -Ref: 9047262 -Ref: index license47262 -Ref: 9147262 -Node: GNU General Public License47794 -Ref: gpl doc47862 -Ref: 9347862 -Ref: gpl gnu-general-public-license47862 -Ref: 9447862 -Ref: gpl gpl47925 -Ref: 9247925 -Node: Index85838 +Node: Pull requests43842 +Ref: contribute id143915 +Ref: 8243915 +Ref: contribute pull-requests43915 +Ref: 8343915 +Node: Docker44721 +Ref: contribute docker44808 +Ref: 8444808 +Ref: contribute id244808 +Ref: 8544808 +Node: Tests45778 +Ref: contribute id345865 +Ref: 8645865 +Ref: contribute tests45865 +Ref: 8745865 +Node: Setup46235 +Ref: contribute setup46296 +Ref: 8846296 +Ref: contribute tests-setup46296 +Ref: 8946296 +Node: Running46472 +Ref: contribute running46533 +Ref: 8a46533 +Ref: contribute tests-running46533 +Ref: 8b46533 +Node: Documentation46814 +Ref: contribute documentation46886 +Ref: 8c46886 +Ref: contribute id446886 +Ref: 8d46886 +Node: Setup<2>47606 +Ref: contribute documentation-setup47679 +Ref: 8e47679 +Ref: contribute id547679 +Ref: 8f47679 +Node: Building47919 +Ref: contribute building47992 +Ref: 9047992 +Ref: contribute documentation-building47992 +Ref: 9147992 +Node: License48297 +Ref: index id148375 +Ref: 9248375 +Ref: index license48375 +Ref: 9348375 +Node: GNU General Public License48907 +Ref: gpl doc48975 +Ref: 9548975 +Ref: gpl gnu-general-public-license48975 +Ref: 9648975 +Ref: gpl gpl49038 +Ref: 9449038 +Node: Index86951  End Tag Table