Mike Gerwitz

Activist for User Freedom

diff options
authorMike Gerwitz <mike.gerwitz@rtspecialty.com>2018-04-23 14:26:32 -0400
committerMike Gerwitz <mike.gerwitz@rtspecialty.com>2018-05-04 10:39:46 -0400
commitf0a469944f68843a7b8347992cbac86b1c4cc319 (patch)
parentb74aa64ae81d0982a0d84353dc444f6dd2d55c21 (diff)
doc: Macros for common library references
* doc/hacking.texi (Hacking): Use mocha, chai, easejs macros. * doc/macros.texi (mocha, chai, easejs): New macros.
2 files changed, 19 insertions, 8 deletions
diff --git a/doc/hacking.texi b/doc/hacking.texi
index c64a2ed..e99c820 100644
--- a/doc/hacking.texi
+++ b/doc/hacking.texi
@@ -19,12 +19,10 @@ This chapter provides general information and guidance for
@dnindex Mocha
@dnindex Chai
For writing classes; interfaces; and traits,
- developers should familiarize themselves with
- @url{https://gnu.org/software/easejs,GNU ease.js}.
+ developers should familiarize themselves with @easejs{}.
For writing unit tests,
developers should be familiarize themselves with
- @url{https://mochajs.org/,Mocha} and
- @url{http://www.chaijs.com/,Chai}.
+ @mocha{} and @chai{}.
For more information on the libraries used by Liza,
see @ref{Libraries}.
@@ -55,7 +53,7 @@ They further introduce maintenance obligations for keeping up with
JavaScript does not natively support the classical object-oriented
model familiar to users of more traditional classical
object-oriented languages like Java, C++, C#, and@tie{}PHP.
-Liza is built using @url{https://gnu.org/software/easejs,GNU ease.js},
+Liza is built using @easejs{},
which provides those familiar features.
The primary language used by developers in the office that created
Liza is@tie{}PHP,
@@ -74,9 +72,8 @@ The @code{class} keyword introduced in ECMAScript@tie{} is largely
@subsection Testing Libraries
@dnindex Mocha
@dnindex Chai
-@url{https://mochajs.org/,Mocha} is used as the test runner for
- JavaScript unit tests.
-@url{http://www.chaijs.com/,Chai} is the assertion library.
+@mocha{} is used as the test runner for JavaScript unit tests.
+@chai{} is the assertion library.
This differs from PHP development where a single system (PHPUnit)
encompasses both of these needs.
diff --git a/doc/macros.texi b/doc/macros.texi
index 53e9941..255dc8a 100644
--- a/doc/macros.texi
+++ b/doc/macros.texi
@@ -248,3 +248,17 @@ See `\ref\' @proguicrefsuffix
@macro proguicrefsuffix{}
in the Liza Program@tie{}UI Compiler manual
@end macro
+@c common links
+@macro mocha{}
+@end macro
+@macro chai{}
+@end macro
+@macro easejs{}
+@url{https://www.gnu.org/software/easejs,GNU ease.js}
+@end macro