diff options
| author | Efraim Flashner <efraim@flashner.co.il> | 2019-03-31 16:39:43 +0300 |
|---|---|---|
| committer | Efraim Flashner <efraim@flashner.co.il> | 2019-03-31 20:51:10 +0300 |
| commit | 36a4366d79a310d05db0de2cf6d5bb3c5e861d4b (patch) | |
| tree | c3968d05b86ac4f9d6cb70bbd34b94708ded305e /gnu | |
| parent | cd9ca20a5d54549db26d9780cbc7b282ec9f0001 (diff) | |
gnu: Fix descriptions to not use quotes.
* gnu/packages/admin.scm (wpa-supplicant-minimal, mingetty, di),
* gnu/packages/audio.scm (fil-plugins),
* gnu/packages/base.scm (make-ld-wrapper, make-glibc-locales),
* gnu/packages/bioinformatics.scm (r-samtools),
* gnu/packages/chez.scm (chez-mit),
* gnu/packages/commencement.scm (make-gcc-toolchain),
* gnu/packages/compression.scm (fastjar),
* gnu/packages/cran.scm (r-maps, r-rcpp),
* gnu/packages/databases.scm (sparql-query),
* gnu/packages/dunst.scm (dunst),
* gnu/packages/ftp.scm (ncftp),
* gnu/packages/gl.scm (freeglut),
* gnu/packages/haskell-check.scm (ghc-tasty-golden),
* gnu/packages/haskell.scm (ghc-case-insensitive, ghc-text,
ghc-haskell-src, ghc-syb, ghc-deepseq-generics, ghc-network-uri,
ghc-rerebase, ghc-zlib),
* gnu/packages/image.scm (jbig2dec),
* gnu/packages/kde-frameworks.scm (kinit, karchive),
* gnu/packages/linux.scm (wireless-tools, perf, module-init-tools, kbd),
* gnu/packages/lirc.scm (lirc),
* gnu/packages/lisp.scm (uglify-js),
* gnu/packages/mate.scm (mate-netbook),
* gnu/packages/microcom.scm (microcom),
* gnu/packages/music.scm (bristol),
* gnu/packages/networking.scm (perl-geo-ip),
* gnu/packages/patchutils.scm (patches),
* gnu/packages/perl-check.scm (perl-test-more-utf8),
* gnu/packages/perl.scm (perl-log-report-optional, perl-file-which,
perl-io-tty, perl-log-any, perl-digest-sha1, perl-class-load,
perl-regexp-common, perl-module-pluggable, perl-class-modifier),
* gnu/packages/python-xyz.scm (python-backports-abc, python-natsort),
* gnu/packages/samba.scm (iniparser),
* gnu/packages/search.scm (mlocate),
* gnu/packages/spice.scm (spice),
* gnu/packages/statistics.scm (r-dt, r-lubridate, r-estimability,
r-commonmark, r-digest, r-viridislite, r-stringr),
* gnu/packages/tex.scm (texlive-latex-changebar),
* gnu/packages/version-control.scm (subversion),
* gnu/packages/w3m.scm (w3m),
* gnu/packages/web.scm (perl-http-parser,
perl-plack-middleware-reverseproxy),
* gnu/packages/xorg.scm (xkeyboard-config, mkfontdir, xcursor-theme,
mkfontscale, xinit, font-alias)[description]: Use @code instead of quotes.
Diffstat (limited to 'gnu')
36 files changed, 133 insertions, 129 deletions
diff --git a/gnu/packages/admin.scm b/gnu/packages/admin.scm index 7f7b2fec3e..d901110e53 100644 --- a/gnu/packages/admin.scm +++ b/gnu/packages/admin.scm @@ -475,8 +475,8 @@ login, passwd, su, groupadd, and useradd.") (synopsis "Getty for the text console") (description "Small console getty that is started on the Linux text console, -asks for a login name and then transfers over to 'login'. It is extended to -allow automatic login and starting any app.") +asks for a login name and then transfers over to @code{login}. It is extended +to allow automatic login and starting any app.") (license license:gpl2+))) (define-public net-base @@ -1140,7 +1140,8 @@ the client stations. It implements key negotiation with a WPA Authenticator and it controls the roaming and IEEE 802.11 authentication/association of the WLAN driver. -This package provides the 'wpa_supplicant' daemon and the 'wpa_cli' command.") +This package provides the @code{wpa_supplicant} daemon and the @code{wpa_cli} +command.") ;; In practice, this is linked against Readline, which makes it GPLv3+. (license license:bsd-3) @@ -2076,7 +2077,7 @@ a new command using the matched rule, and runs it.") (home-page "https://www.gentoo.com/di/") (synopsis "Advanced df like disk information utility") (description - "'di' is a disk information utility, displaying everything that your + "@code{di} is a disk information utility, displaying everything that your @code{df} command does and more. It features the ability to display your disk usage in whatever format you prefer. It is designed to be highly portable and produce uniform output across heterogeneous networks.") diff --git a/gnu/packages/audio.scm b/gnu/packages/audio.scm index aa99382f79..fb119f870d 100644 --- a/gnu/packages/audio.scm +++ b/gnu/packages/audio.scm @@ -943,7 +943,7 @@ gain controls. There is also a global bypass switch and gain control. The 2nd order resonant filters are implemented using a Mitra-Regalia style lattice filter, which is stable even while parameters are being changed. -All switches and controls are internally smoothed, so they can be used 'live' +All switches and controls are internally smoothed, so they can be used @code{live} without any clicks or zipper noises. This makes this plugin suitable for use in systems that allow automation of plugin control ports, such as Ardour, or for stage use.") diff --git a/gnu/packages/base.scm b/gnu/packages/base.scm index db9cca6faf..91f8b03c83 100644 --- a/gnu/packages/base.scm +++ b/gnu/packages/base.scm @@ -600,9 +600,9 @@ wrapper for the cross-linker for that target, called 'TARGET-ld'." #t))))) (synopsis "The linker wrapper") (description - "The linker wrapper (or 'ld-wrapper') wraps the linker to add any -missing '-rpath' flags, and to detect any misuse of libraries outside of the -store.") + "The linker wrapper (or @code{ld-wrapper}) wraps the linker to add any +missing @code{-rpath} flags, and to detect any misuse of libraries outside of +the store.") (home-page "https://www.gnu.org/software/guix//") (license gpl3+))) @@ -1019,8 +1019,8 @@ with the Linux kernel.") (synopsis "All the locales supported by the GNU C Library") (description "This package provides all the locales supported by the GNU C Library, -more than 400 in total. To use them set the 'LOCPATH' environment variable to -the 'share/locale' sub-directory of this package.") +more than 400 in total. To use them set the @code{LOCPATH} environment variable +to the @code{share/locale} sub-directory of this package.") (outputs '("out")) ;110+ MiB (native-search-paths '()) (arguments diff --git a/gnu/packages/bioinformatics.scm b/gnu/packages/bioinformatics.scm index c647d48aec..8f6a37a4f8 100644 --- a/gnu/packages/bioinformatics.scm +++ b/gnu/packages/bioinformatics.scm @@ -7765,10 +7765,10 @@ biological sequences or sets of sequences.") (home-page "https://bioconductor.org/packages/release/bioc/html/Rsamtools.html") (synopsis "Interface to samtools, bcftools, and tabix") (description - "This package provides an interface to the 'samtools', 'bcftools', and -'tabix' utilities for manipulating SAM (Sequence Alignment / Map), FASTA, -binary variant call (BCF) and compressed indexed tab-delimited (tabix) -files.") + "This package provides an interface to the @code{samtools}, +@code{bcftools}, and @code{tabix} utilities for manipulating SAM (Sequence +Alignment / Map), FASTA, binary variant call (BCF) and compressed indexed +tab-delimited (tabix) files.") (license license:expat))) (define-public r-delayedarray diff --git a/gnu/packages/chez.scm b/gnu/packages/chez.scm index 7d0042872e..7e9f00f4c4 100644 --- a/gnu/packages/chez.scm +++ b/gnu/packages/chez.scm @@ -558,7 +558,7 @@ strings.") (synopsis "MIT/GNU Scheme compatibility library for Chez Scheme") (description "This package provides a set of MIT/GNU Scheme compatibility libraries for Chez Scheme. The main goal was to provide the functionality -required to port the program 'Scmutils' to Chez Scheme.") +required to port the program @code{Scmutils} to Chez Scheme.") (license gpl3+))) (define-public chez-scmutils diff --git a/gnu/packages/commencement.scm b/gnu/packages/commencement.scm index 0aa65fe638..b07630a54d 100644 --- a/gnu/packages/commencement.scm +++ b/gnu/packages/commencement.scm @@ -1050,7 +1050,7 @@ COREUTILS-FINAL vs. COREUTILS, etc." (description "This package provides a complete GCC tool chain for C/C++ development to be installed in user profiles. This includes GCC, as well as libc (headers -and binaries, plus debugging symbols in the 'debug' output), and Binutils.") +and binaries, plus debugging symbols in the @code{debug} output), and Binutils.") (home-page "https://gcc.gnu.org/") (outputs '("out" "debug" "static")) diff --git a/gnu/packages/compression.scm b/gnu/packages/compression.scm index fee657c3f8..ec80dc92ec 100644 --- a/gnu/packages/compression.scm +++ b/gnu/packages/compression.scm @@ -158,8 +158,8 @@ the @code{zlib} source.") (home-page "https://savannah.nongnu.org/projects/fastjar") (synopsis "Replacement for Sun's 'jar' utility") (description - "FastJar is an attempt to create a much faster replacement for Sun's 'jar' -utility. Instead of being written in Java, FastJar is written in C.") + "FastJar is an attempt to create a much faster replacement for Sun's +@code{jar} utility. Instead of being written in Java, FastJar is written in C.") (license license:gpl2+))) (define-public libtar diff --git a/gnu/packages/cran.scm b/gnu/packages/cran.scm index 40a0ed4759..f741b20f15 100644 --- a/gnu/packages/cran.scm +++ b/gnu/packages/cran.scm @@ -929,8 +929,8 @@ data store designed for maximum speed.") (home-page "https://cran.r-project.org/web/packages/maps") (synopsis "Draw geographical maps") (description "This package provides an R module for display of maps. -Projection code and larger maps are in separate packages ('mapproj' and -'mapdata').") +Projection code and larger maps are in separate packages (@code{mapproj} and +@code{mapdata}).") (license license:gpl2))) (define-public r-mapproj @@ -1351,9 +1351,9 @@ a seamless integration of R and C++. Many R data types and objects can be mapped back and forth to C++ equivalents which facilitates both writing of new code as well as easier integration of third-party libraries. Documentation about Rcpp is provided by several vignettes included in this package, via the -'Rcpp Gallery' site at <http://gallery.rcpp.org>, the paper by Eddelbuettel +@code{Rcpp Gallery} site at <http://gallery.rcpp.org>, the paper by Eddelbuettel and Francois (2011, JSS), and the book by Eddelbuettel (2013, Springer); see -'citation(\"Rcpp\")' for details on these last two.") +@code{citation(\"Rcpp\")} for details on these last two.") (license license:gpl2+))) (define-public r-bindr diff --git a/gnu/packages/databases.scm b/gnu/packages/databases.scm index afc6d7a307..3551be5596 100644 --- a/gnu/packages/databases.scm +++ b/gnu/packages/databases.scm @@ -986,7 +986,7 @@ data in a single database. RocksDB is partially based on @code{LevelDB}.") (home-page "https://github.com/tialaramex/sparql-query/") (synopsis "Command-line tool for accessing SPARQL endpoints over HTTP") (description "Sparql-query is a command-line tool for accessing SPARQL -endpoints over HTTP. It has been intentionally designed to 'feel' similar to +endpoints over HTTP. It has been intentionally designed to @code{feel} similar to tools for interrogating SQL databases. For example, you can enter a query over several lines, using a semi-colon at the end of a line to indicate the end of your query. It also supports readline so that you can more easily recall and diff --git a/gnu/packages/dunst.scm b/gnu/packages/dunst.scm index 7328e442cf..31b7f58758 100644 --- a/gnu/packages/dunst.scm +++ b/gnu/packages/dunst.scm @@ -73,6 +73,6 @@ (synopsis "Customizable and lightweight notification daemon") (description "Dunst is a highly configurable and minimalistic notification daemon. -It provides 'org.freedesktop.Notifications' D-Bus service, so it is +It provides @code{org.freedesktop.Notifications} D-Bus service, so it is started automatically on the first call via D-Bus.") (license license:bsd-3))) diff --git a/gnu/packages/ftp.scm b/gnu/packages/ftp.scm index 68ad8da716..96953d6fd5 100644 --- a/gnu/packages/ftp.scm +++ b/gnu/packages/ftp.scm @@ -134,9 +134,9 @@ reliability in mind.") (synopsis "Command-line File Transfer Protocol (FTP) client") (description "NcFTP Client (or just NcFTP) is a set of command-line programs to access -File Transfer Protocol (FTP) servers. This includes 'ncftp', an interactive -FTP browser, as well as non-interactive commands such as 'ncftpput' and -'ncftpget'.") +File Transfer Protocol (FTP) servers. This includes @code{ncftp}, an interactive +FTP browser, as well as non-interactive commands such as @code{ncftpput} and +@code{ncftpget}.") (license clarified-artistic))) diff --git a/gnu/packages/gl.scm b/gnu/packages/gl.scm index 743932fd07..57e65e29b5 100644 --- a/gnu/packages/gl.scm +++ b/gnu/packages/gl.scm @@ -120,7 +120,7 @@ as ASCII text.") "Freeglut is a completely Free/OpenSourced alternative to the OpenGL Utility Toolkit (GLUT) library. GLUT was originally written by Mark Kilgard to support the sample programs in the -second edition OpenGL 'RedBook'. Since then, GLUT has been used +second edition OpenGL @code{RedBook}. Since then, GLUT has been used in a wide variety of practical applications because it is simple, widely available and highly portable. diff --git a/gnu/packages/haskell-check.scm b/gnu/packages/haskell-check.scm index 19eb40eaa4..fa2bd0d652 100644 --- a/gnu/packages/haskell-check.scm +++ b/gnu/packages/haskell-check.scm @@ -148,9 +148,9 @@ Haskell test framework.") "https://github.com/feuerbach/tasty-golden") (synopsis "Golden tests support for tasty") (description - "This package provides support for 'golden testing'. A @dfn{golden test} -is an IO action that writes its result to a file. To pass the test, this -output file should be identical to the corresponding 'golden' file, which + "This package provides support for @code{golden testing}. A @dfn{golden +test} is an IO action that writes its result to a file. To pass the test, this +output file should be identical to the corresponding @code{golden} file, which contains the correct result for the test.") (license license:expat))) diff --git a/gnu/packages/haskell.scm b/gnu/packages/haskell.scm index 2a5ba2a706..a23dfe9ae6 100644 --- a/gnu/packages/haskell.scm +++ b/gnu/packages/haskell.scm @@ -1157,7 +1157,7 @@ them.") (synopsis "Support for manipulating Haskell source code") (description - "The 'haskell-src' package provides support for manipulating Haskell + "The @code{haskell-src} package provides support for manipulating Haskell source code. The package provides a lexer, parser and pretty-printer, and a definition of a Haskell abstract syntax tree (AST). Common uses of this package are to parse or generate Haskell 98 code.") @@ -2360,11 +2360,11 @@ literals.") "Compression and decompression in the gzip and zlib formats") (description "This package provides a pure interface for compressing and decompressing -streams of data represented as lazy 'ByteString's. It uses the zlib C library -so it has high performance. It supports the 'zlib', 'gzip' and 'raw' -compression formats. It provides a convenient high level API suitable for -most tasks and for the few cases where more control is needed it provides -access to the full zlib feature set.") +streams of data represented as lazy @code{ByteString}s. It uses the zlib C +library so it has high performance. It supports the @code{zlib}, @code{gzip} +and @code{raw} compression formats. It provides a convenient high level API +suitable for most tasks and for the few cases where more control is needed it +provides access to the full zlib feature set.") (license license:bsd-3))) (define-public ghc-stm @@ -2467,7 +2467,7 @@ are not exception safe and can be broken by @code{killThread}.") "An efficient packed, immutable Unicode text type (both strict and lazy), with a powerful loop fusion optimization framework. -The 'Text' type represents Unicode character strings, in a time and +The @code{Text} type represents Unicode character strings, in a time and space-efficient manner. This package provides text processing capabilities that are optimized for performance critical use, both in terms of large data quantities and high speed.") @@ -3800,10 +3800,10 @@ writing to stdout and other handles.") "https://github.com/basvandijk/case-insensitive") (synopsis "Case insensitive string comparison") (description - "The module 'Data.CaseInsensitive' provides the 'CI' type constructor -which can be parameterised by a string-like type like: 'String', 'ByteString', -'Text', etc.. Comparisons of values of the resulting type will be insensitive -to cases.") + "The module @code{Data.CaseInsensitive} provides the @code{CI} type +constructor which can be parameterised by a string-like type like: +@code{String}, @code{ByteString}, @code{Text}, etc. Comparisons of values of +the resulting type will be insensitive to cases.") (license license:bsd-3))) (define-public ghc-syb @@ -3830,7 +3830,7 @@ to cases.") (description "This package contains the generics system described in the /Scrap Your Boilerplate/ papers (see @uref{http://www.cs.uu.nl/wiki/GenericProgramming/SYB, the website}). It -defines the 'Data' class of types permitting folding and unfolding of +defines the @code{Data} class of types permitting folding and unfolding of constructor applications, instances of this class for primitive types, and a variety of traversals.") (license license:bsd-3))) @@ -4323,8 +4323,8 @@ interface.") "https://github.com/haskell/network-uri") (synopsis "Library for URI manipulation") (description "This package provides an URI manipulation interface. In -'network-2.6' the 'Network.URI' module was split off from the 'network' -package into this package.") +@code{network-2.6} the @code{Network.URI} module was split off from the +@code{network} package into this package.") (license license:bsd-3))) (define-public ghc-ansi-terminal @@ -5724,7 +5724,7 @@ using a simple box model.") (description "This package provides a @code{GHC.Generics}-based @code{Control.DeepSeq.Generics.genericRnf} function which can be used for -providing an 'rnf' implementation.") +providing an @code{rnf} implementation.") (license license:bsd-3))) (define-public ghc-string-qq @@ -9430,7 +9430,7 @@ the community, with the missing features being added with pull-requests.") `(("ghc-rebase" ,ghc-rebase))) (home-page "https://github.com/nikita-volkov/rerebase") (synopsis "Reexports from ``base'' with many other standard libraries") - (description "A rich drop-in replacement for ``base''. For details and + (description "A rich drop-in replacement for @code{base}. For details and documentation please visit @uref{https://github.com/nikita-volkov/rerebase, the project's home page}.") (license license:expat))) diff --git a/gnu/packages/image.scm b/gnu/packages/image.scm index d363c445b7..9fc29ec284 100644 --- a/gnu/packages/image.scm +++ b/gnu/packages/image.scm @@ -545,7 +545,7 @@ arithmetic ops.") (arguments '(#:configure-flags '("--disable-static"))) (synopsis "Decoder of the JBIG2 image compression format") (description - "JBIG2 is designed for lossy or lossless encoding of 'bilevel' (1-bit + "JBIG2 is designed for lossy or lossless encoding of @code{bilevel} (1-bit monochrome) images at moderately high resolution, and in particular scanned paper documents. In this domain it is very efficient, offering compression ratios on the order of 100:1. diff --git a/gnu/packages/kde-frameworks.scm b/gnu/packages/kde-frameworks.scm index 10a1dfe0d1..ec735d8903 100644 --- a/gnu/packages/kde-frameworks.scm +++ b/gnu/packages/kde-frameworks.scm @@ -418,7 +418,7 @@ documentation.") (home-page "https://community.kde.org/Frameworks") (synopsis "Qt 5 addon providing access to numerous types of archives") (description "KArchive provides classes for easy reading, creation and -manipulation of 'archive' formats like ZIP and TAR. +manipulation of @code{archive} formats like ZIP and TAR. It also provides transparent compression and decompression of data, like the GZip format, via a subclass of QIODevice.") @@ -2585,8 +2585,9 @@ in applications using the KDE Frameworks.") (synopsis "Library to speed up start of applications on KDE workspaces") (description "Kdeinit is a process launcher similar to init used for booting UNIX. It launches processes by forking and then loading a dynamic library which -contains a 'kdemain(...)' function. Using kdeinit to launch KDE applications -makes starting KDE applications faster and reduces memory consumption.") +contains a @code{kdemain(@dots{})} function. Using kdeinit to launch KDE +applications makes starting KDE applications faster and reduces memory +consumption.") ;; dual licensed (license (list license:lgpl2.0+ license:lgpl2.1+)))) diff --git a/gnu/packages/linux.scm b/gnu/packages/linux.scm index b4a80bb2a0..9e4261eb02 100644 --- a/gnu/packages/linux.scm +++ b/gnu/packages/linux.scm @@ -1996,7 +1996,7 @@ system.") (description "This package contains keytable files and keyboard utilities compatible for systems using the Linux kernel. This includes commands such as -'loadkeys', 'setfont', 'kbdinfo', and 'chvt'.") +@code{loadkeys}, @code{setfont}, @code{kbdinfo}, and @code{chvt}.") (license license:gpl2+))) (define-public loadkeys-static @@ -2302,7 +2302,7 @@ mapper. Kernel components are part of Linux-libre.") #:tests? #f)) (synopsis "Tools for manipulating Linux Wireless Extensions") (description "Wireless Tools are used to manipulate the now-deprecated -Linux Wireless Extensions; consider using 'iw' instead. The Wireless +Linux Wireless Extensions; consider using @code{iw} instead. The Wireless Extension was an interface allowing you to set Wireless LAN specific parameters and get the specific stats. It is deprecated in favor the nl80211 interface.") @@ -2660,7 +2660,7 @@ in a digital read-out.") with support in the Linux kernel. perf can instrument CPU performance counters, tracepoints, kprobes, and uprobes (dynamic tracing). It is capable of lightweight profiling. This package contains the user-land tools and in -particular the 'perf' command.") +particular the @code{perf} command.") (license (package-license linux-libre)))) (define-public pflask @@ -4016,8 +4016,8 @@ the default @code{nsswitch} and the experimental @code{umich_ldap}.") (home-page "https://www.kernel.org/pub/linux/utils/kernel/module-init-tools/") (synopsis "Tools for loading and managing Linux kernel modules") (description - "Tools for loading and managing Linux kernel modules, such as `modprobe', -`insmod', `lsmod', and more.") + "Tools for loading and managing Linux kernel modules, such as +@code{modprobe}, @code{insmod}, @code{lsmod}, and more.") (license license:gpl2+))) (define-public mcelog diff --git a/gnu/packages/lirc.scm b/gnu/packages/lirc.scm index 627c79f979..5e77f1ddc2 100644 --- a/gnu/packages/lirc.scm +++ b/gnu/packages/lirc.scm @@ -96,10 +96,10 @@ (synopsis "Linux Infrared Remote Control") (description "LIRC allows computers to send and receive IR signals of many commonly -used remote controls. The most important part of LIRC is the 'lircd' daemon -that decodes IR signals received by the device drivers. The second daemon -program 'lircmd' allows to translate IR signals to mouse movements. The -user space applications allow you to control your computer with a remote +used remote controls. The most important part of LIRC is the @code{lircd} +daemon that decodes IR signals received by the device drivers. The second +daemon program @code{lircmd} allows to translate IR signals to mouse movements. +The user space applications allow you to control your computer with a remote control: you can send X events to applications, start programs and much more on just one button press.") (license license:gpl2+))) diff --git a/gnu/packages/lisp.scm b/gnu/packages/lisp.scm index 87dcf36372..d92d69985b 100644 --- a/gnu/packages/lisp.scm +++ b/gnu/packages/lisp.scm @@ -1467,7 +1467,7 @@ compressor. It works on data produced by @code{parse-js} to generate a @item reduce variable names (usually to single letters) @item join consecutive @code{var} statements @item resolve simple binary expressions -@item group most consecutive statements using the ``sequence'' operator (comma) +@item group most consecutive statements using the @code{sequence} operator (comma) @item remove unnecessary blocks @item convert @code{IF} expressions in various ways that result in smaller code @item remove some unreachable code diff --git a/gnu/packages/mate.scm b/gnu/packages/mate.scm index 16e9148506..f02bb41cda 100644 --- a/gnu/packages/mate.scm +++ b/gnu/packages/mate.scm @@ -1148,7 +1148,7 @@ can be used as backgrounds in the MATE Desktop environment.") @item Allows you to set basic rules for a window type, such as maximise|undecorate @item Allows exceptions to the rules, based on string matching for window name and window class. -@item Allows 'reversing' of rules when the user manually changes something: +@item Allows @code{reversing} of rules when the user manually changes something: Re-decorates windows on un-maximise. @end enumerate\n") (license license:gpl3+))) diff --git a/gnu/packages/microcom.scm b/gnu/packages/microcom.scm index 67fd5fe355..3a1ec1d3cb 100644 --- a/gnu/packages/microcom.scm +++ b/gnu/packages/microcom.scm @@ -46,6 +46,6 @@ (synopsis "Minimalistic serial line terminal program") (description "Microcom is a minimalistic terminal program for accessing devices via a serial connection. It features connection via RS232 serial -interfaces (including setting of transfer rates) as well as in `telnetmode' +interfaces (including setting of transfer rates) as well as in @code{telnetmode} as specified in rfc2217 and a (Linux specific) CAN mode.") (license gpl2+))) diff --git a/gnu/packages/music.scm b/gnu/packages/music.scm index 442796bc1d..1707dfa944 100644 --- a/gnu/packages/music.scm +++ b/gnu/packages/music.scm @@ -1630,7 +1630,7 @@ mixing, FFT scopes, MIDI automation and full scriptability in Scheme.") (home-page "http://bristol.sourceforge.net/") (synopsis "Synthesizer emulator") (description - "Bristol is an emulation package for a number of different 'classic' + "Bristol is an emulation package for a number of different @code{classic} synthesizers including additive and subtractive and a few organs. The application consists of the engine, which is called bristol, and its own GUI library called brighton that represents all the emulations. There are diff --git a/gnu/packages/networking.scm b/gnu/packages/networking.scm index d3deb78516..e266ea0832 100644 --- a/gnu/packages/networking.scm +++ b/gnu/packages/networking.scm @@ -1108,8 +1108,8 @@ offline emulation of DNS.") (home-page "https://metacpan.org/release/Geo-IP") (synopsis "Look up location and network information by IP Address in Perl") - (description "The Perl module 'Geo::IP'. It looks up location and network -information by IP Address.") + (description "The Perl module @code{Geo::IP}. It looks up location and +network information by IP Address.") (license license:perl-license))) (define-public perl-io-socket-inet6 diff --git a/gnu/packages/patchutils.scm b/gnu/packages/patchutils.scm index 09f5afbb28..ec669e2e23 100644 --- a/gnu/packages/patchutils.scm +++ b/gnu/packages/patchutils.scm @@ -216,7 +216,7 @@ refreshed, and more.") #:python ,python-2)) ;not compatible with Python 3 (synopsis "Patch tracking tool") (description - "'Patches' is a patch-tracking tool initially written for the QEMU + "@code{Patches} is a patch-tracking tool initially written for the QEMU project. It provides commands that build a database of patches from a mailing list, and commands that can search that database. It allows users to track the status of a patch, apply patches, and search for patches---all that from diff --git a/gnu/packages/perl-check.scm b/gnu/packages/perl-check.scm index aae83e5771..a25c43cc32 100644 --- a/gnu/packages/perl-check.scm +++ b/gnu/packages/perl-check.scm @@ -801,9 +801,10 @@ to gmtime,time or localtime.") (home-page "https://metacpan.org/release/Test-More-UTF8") (synopsis "Enhance Test::More for UTF8-based projects") (description "@code{Test::More::UTF8} is a simple extension for the widely -used @code{Test::More} module. By default, it will do a @code{binmode ':utf8'} -on all of @code{Test::Builder}'s output handles thus enabling the easy use -flagged strings without warnings like \"Wide character in print @dots{}\"") +used @code{Test::More} module. By default, it will do a @code{binmode +@code{:utf8}} on all of @code{Test::Builder}'s output handles thus enabling the +easy use flagged strings without warnings like \"Wide character in print +@dots{}\"") (license perl-license))) (define-public perl-test-most diff --git a/gnu/packages/perl.scm b/gnu/packages/perl.scm index 038d551fb1..ff387354e7 100644 --- a/gnu/packages/perl.scm +++ b/gnu/packages/perl.scm @@ -1190,11 +1190,11 @@ write accessor methods for your objects that perform standard tasks.") ("perl-test-requires" ,perl-test-requires))) (home-page "https://metacpan.org/release/Class-Method-Modifiers") (synopsis "Moose-like method modifiers") - (description "Class::Method::Modifiers provides three modifiers: 'before', -'around', and 'after'. 'before' and 'after' are run just before and after the -method they modify, but can not really affect that original method. 'around' -is run in place of the original method, with a hook to easily call that -original method.") + (description "Class::Method::Modifiers provides three modifiers: +@code{before}, @code{around}, and @code{after}. @code{before} and @code{after} +are run just before and after the method they modify, but can not really affect +that original method. @code{around} is run in place of the original method, +with a hook to easily call that original method.") (license (package-license perl)))) (define-public perl-class-singleton @@ -2938,7 +2938,7 @@ input a message of arbitrary length and produces as output a (build-system perl-build-system) (synopsis "Perl implementation of the SHA-1 message digest algorithm") (description - "This package provides 'Digest::SHA1', an implementation of the NIST + "This package provides @code{Digest::SHA1}, an implementation of the NIST SHA-1 message digest algorithm for use by Perl programs.") (home-page "https://metacpan.org/release/Digest-SHA1") (license (package-license perl)))) @@ -3481,7 +3481,7 @@ provide a quick dropin when such functionality is needed.") (home-page "https://metacpan.org/release/File-HomeDir") (synopsis "Find your home and other directories on any platform") (description "File::HomeDir is a module for locating the directories that -are \"owned\" by a user (typically your user) and to solve the various issues +are @code{owned} by a user (typically your user) and to solve the various issues that arise trying to find them consistently across a wide variety of platforms.") (license (package-license perl)))) @@ -4266,8 +4266,8 @@ filehandles; in particular, IO::Scalar, IO::ScalarArray, and IO::Lines.") (home-page "https://metacpan.org/release/IO-Tty") (synopsis "Perl interface to pseudo ttys") (description - "This package provides the 'IO::Pty' and 'IO::Tty' Perl interfaces to -pseudo ttys.") + "This package provides the @code{IO::Pty} and @code{IO::Tty} Perl +interfaces to pseudo ttys.") (license (package-license perl)))) (define-public perl-ipc-cmd @@ -4533,7 +4533,7 @@ application, in turn, may choose one or more logging mechanisms via @code{Log::Any} has a very tiny footprint and no dependencies beyond Perl itself, which makes it appropriate for even small CPAN modules to use. It -defaults to 'null' logging activity, so a module can safely log without +defaults to @code{null} logging activity, so a module can safely log without worrying about whether the application has chosen (or will ever choose) a logging mechanism.") (license (package-license perl)))) @@ -4606,7 +4606,7 @@ widely popular (Java-based) Log4j logging package in pure Perl.") "This module allows libraries to have a dependency to a small module instead of the full Log-Report distribution. The full power of @code{Log::Report} is only released when the main program uses that module. -In that case, the module using the 'Optional' will also use the full +In that case, the module using the @code{Optional} will also use the full @code{Log::Report}, otherwise the dressed-down @code{Log::Report::Minimal} version.") (license (package-license perl)))) @@ -5274,7 +5274,7 @@ examine the contents, and perform some simple tasks. It can also load the (home-page "https://metacpan.org/release/Module-Pluggable") (synopsis "Give your Perl module the ability to have plugins") (description "This module provides a simple but extensible way of having -'plugins' for your Perl module.") +@code{plugins} for your Perl module.") (license (package-license perl)))) (define-public perl-module-runtime @@ -7130,7 +7130,7 @@ of @code{ref}.") (build-system perl-build-system) (synopsis "Provide commonly requested regular expressions") (description - "This module exports a single hash (`%RE') that stores or generates + "This module exports a single hash (@code{%RE}) that stores or generates commonly needed regular expressions. Patterns currently provided include: balanced parentheses and brackets, delimited text (with escapes), integers and floating-point numbers in any base (up to 36), comments in 44 languages, diff --git a/gnu/packages/python-xyz.scm b/gnu/packages/python-xyz.scm index 03a83022a1..413d8a822f 100644 --- a/gnu/packages/python-xyz.scm +++ b/gnu/packages/python-xyz.scm @@ -5644,7 +5644,7 @@ It is written entirely in Python.") (synopsis "Backport of additions to the 'collections.abc' module") (description "Python-backports-abc provides a backport of additions to the -'collections.abc' module in Python-3.5.") +@code{collections.abc} module in Python-3.5.") (license license:psfl))) (define-public python2-backports-abc @@ -10341,12 +10341,12 @@ Python to manipulate OpenDocument 1.2 files.") (description "Natsort lets you apply natural sorting on lists instead of lexicographical. If you use the built-in @code{sorted} method in python -on a list such as @code{['a20', 'a9', 'a1', 'a4', 'a10']}, it would be -returned as @code{['a1', 'a10', 'a20', 'a4', 'a9']}. Natsort provides a -function @code{natsorted} that identifies numbers and sorts them separately -from strings. It can also sort version numbers, real numbers, mixed types -and more, and comes with a shell command @command{natsort} that exposes this -functionality in the command line.") +on a list such as @code{[@code{a20}, @code{a9}, @code{a1}, @code{a4}, +@code{a10}]}, it would be returned as @code{[@code{a1}, @code{a10}, @code{a20}, +@code{a4}, @code{a9}]}. Natsort provides a function @code{natsorted} that +identifies numbers and sorts them separately from strings. It can also sort +version numbers, real numbers, mixed types and more, and comes with a shell +command @command{natsort} that exposes this functionality in the command line.") (license license:expat) (properties `((python2-variant . ,(delay python2-natsort)))))) diff --git a/gnu/packages/samba.scm b/gnu/packages/samba.scm index f4bd0e3f11..2ebbc29a79 100644 --- a/gnu/packages/samba.scm +++ b/gnu/packages/samba.scm @@ -144,7 +144,7 @@ the Linux kernel CIFS client.") (home-page "https://github.com/ndevilla/iniparser") (synopsis "Standalone ini file parsing library") (description - "iniparser is a free stand-alone `ini' file parsing library (Windows + "iniparser is a free stand-alone @code{ini} file parsing library (Windows configuration files). It is written in portable ANSI C and should compile anywhere.") (license x11))) diff --git a/gnu/packages/search.scm b/gnu/packages/search.scm index 9969cad8ac..a127d5ca34 100644 --- a/gnu/packages/search.scm +++ b/gnu/packages/search.scm @@ -243,7 +243,7 @@ interfaces, or a C API.") (home-page "https://pagure.io/mlocate") (synopsis "Locate files on the file system") (description - "mlocate is a locate/updatedb implementation. The 'm' stands for + "mlocate is a locate/updatedb implementation. The @code{m} stands for \"merging\": @code{updatedb} reuses the existing database to avoid rereading most of the file system, which makes it faster and does not trash the system caches as much. The locate(1) utility is intended to be completely compatible diff --git a/gnu/packages/spice.scm b/gnu/packages/spice.scm index 55b551a119..e9e9042bd1 100644 --- a/gnu/packages/spice.scm +++ b/gnu/packages/spice.scm @@ -217,7 +217,7 @@ which allows users to view a desktop computing environment.") #:parallel-tests? #f)) (synopsis "Server implementation of the SPICE protocol") (description "SPICE is a remote display system built for virtual -environments which allows you to view a computing 'desktop' environment +environments which allows you to view a computing @code{desktop} environment not only on the machine where it is running, but from anywhere on the Internet and from a wide variety of machine architectures.") (home-page "https://www.spice-space.org") diff --git a/gnu/packages/statistics.scm b/gnu/packages/statistics.scm index d473c7c06d..d89a18e2b9 100644 --- a/gnu/packages/statistics.scm +++ b/gnu/packages/statistics.scm @@ -2,7 +2,7 @@ ;;; Copyright © 2015, 2016, 2017, 2018, 2019 Ricardo Wurmus <rekado@elephly.net> ;;; Copyright © 2015 Vicente Vera Parra <vicentemvp@gmail.com> ;;; Copyright © 2016 Andreas Enge <andreas@enge.fr> -;;; Copyright © 2016, 2017 Efraim Flashner <efraim@flashner.co.il> +;;; Copyright © 2016, 2017, 2019 Efraim Flashner <efraim@flashner.co.il> ;;; Copyright © 2016 Pjotr Prins <pjotr.guix@thebird.nl> ;;; Copyright © 2016 Roel Janssen <roel@gnu.org> ;;; Copyright © 2016 Ben Woodcroft <donttrustben@gmail.com> @@ -802,10 +802,10 @@ effects of different types of color-blindness.") (home-page "http://dirk.eddelbuettel.com/code/digest.html") (synopsis "Create cryptographic hash digests of R objects") (description - "This package contains an implementation of a function 'digest()' for the -creation of hash digests of arbitrary R objects (using the md5, sha-1, + "This package contains an implementation of a function @code{digest()} for +the creation of hash digests of arbitrary R objects (using the md5, sha-1, sha-256, crc32, xxhash and murmurhash algorithms) permitting easy comparison -of R language objects, as well as a function 'hmac()' to create hash-based +of R language objects, as well as a function @code{hmac()} to create hash-based message authentication code. Please note that this package is not meant to be deployed for cryptographic @@ -827,7 +827,7 @@ OpenSSL should be used.") (home-page "https://cran.r-project.org/web/packages/estimability") (synopsis "Tools for assessing estimability of linear predictions") (description "Provides tools for determining estimability of linear -functions of regression coefficients, and 'epredict' methods that handle +functions of regression coefficients, and @code{epredict} methods that handle non-estimable cases correctly.") (license license:gpl2+))) @@ -1063,7 +1063,7 @@ transliteration, concatenation, date-time formatting and parsing, etc.") (synopsis "Simple, consistent wrappers for common string operations") (description "Stringr is a consistent, simple and easy to use set of wrappers around -the fantastic 'stringi' package. All function and argument names (and +the fantastic @code{stringi} package. All function and argument names (and positions) are consistent, all functions deal with \"NA\"'s and zero length vectors in the same way, and the output from one function is easy to feed into the input of another.") @@ -2274,9 +2274,9 @@ other packages.") (synopsis "CommonMark and Github Markdown Rendering in R") (description "The CommonMark specification defines a rationalized version of markdown -syntax. This package uses the 'cmark' reference implementation for converting -markdown text into various formats including HTML, LaTeX and groff man. In -addition, it exposes the markdown parse tree in XML format. The latest +syntax. This package uses the @code{cmark} reference implementation for +converting markdown text into various formats including HTML, LaTeX and groff +man. In addition, it exposes the markdown parse tree in XML format. The latest version of this package also adds support for Github extensions including tables, autolinks and strikethrough text.") (license license:bsd-2))) @@ -3165,8 +3165,8 @@ using the multicore functionality of the parallel package.") (synopsis "R wrapper of the DataTables JavaScript library") (description "This package allows for data objects in R to be rendered as HTML tables -using the JavaScript library 'DataTables' (typically via R Markdown or Shiny). -The 'DataTables' library has been included in this R package.") +using the JavaScript library @code{DataTables} (typically via R Markdown or +Shiny). The @code{DataTables} library has been included in this R package.") ;; The DT package as a whole is distributed under GPLv3. The DT package ;; inludes other software components under different licenses: ;; @@ -3688,13 +3688,14 @@ most common form of color blindness.") (home-page "https://github.com/sjmgarnier/viridisLite") (synopsis "Default color maps from matplotlib") (description - "This package is a port of the new @code{matplotlib} color maps ('viridis', -'magma', 'plasma' and 'inferno') to R. matplotlib is a popular plotting -library for Python. These color maps are designed in such a way that they -will analytically be perfectly perceptually-uniform, both in regular form and -also when converted to black-and-white. They are also designed to be -perceived by readers with the most common form of color blindness. This is -the 'lite' version of the more complete @code{viridis} package.") + "This package is a port of the new @code{matplotlib} color maps +(@code{viridis}, @code{magma}, @code{plasma} and @code{inferno}) to R. +matplotlib is a popular plotting library for Python. These color maps are +designed in such a way that they will analytically be perfectly +perceptually-uniform, both in regular form and also when converted to +black-and-white. They are also designed to be perceived by readers with the +most common form of color blindness. This is the @code{lite} version of the +more complete @code{viridis} package.") (license license:expat))) (define-public r-tidyselect @@ -5528,7 +5529,7 @@ is supported.") "This package provides functions to work with date-times and time-spans: fast and user friendly parsing of date-time data, extraction and updating of components of a date-time (years, months, days, hours, minutes, and seconds), -algebraic manipulation on date-time and time-span objects. The 'lubridate' +algebraic manipulation on date-time and time-span objects. The @code{lubridate} package has a consistent and memorable syntax that makes working with dates easy and fun.") (license license:gpl2))) diff --git a/gnu/packages/tex.scm b/gnu/packages/tex.scm index 5b29937672..579dacafef 100644 --- a/gnu/packages/tex.scm +++ b/gnu/packages/tex.scm @@ -3416,8 +3416,8 @@ command.") (description "Identify areas of text to be marked with changebars with the @code{\\cbstart} and @code{\\cbend} commands; the bars may be coloured. The -package uses 'drivers' to place the bars; the available drivers can work with -@code{dvitoln03}, @code{dvitops}, @code{dvips}, the emTeX and TeXtures DVI +package uses @code{drivers} to place the bars; the available drivers can work +with @code{dvitoln03}, @code{dvitops}, @code{dvips}, the emTeX and TeXtures DVI drivers, and VTeX and pdfTeX.") (license license:lppl))) diff --git a/gnu/packages/version-control.scm b/gnu/packages/version-control.scm index 667b2881b1..db096d8587 100644 --- a/gnu/packages/version-control.scm +++ b/gnu/packages/version-control.scm @@ -1366,7 +1366,7 @@ following features: (home-page "https://subversion.apache.org/") (synopsis "Revision control system") (description - "Subversion (aka. ``svn'') exists to be recognized and adopted as a + "@dfn{Subversion} (svn) exists to be recognized and adopted as a centralized version control system characterized by its reliability as a safe haven for valuable data; the simplicity of its model and usage; and its ability to support the needs of a wide variety of users and diff --git a/gnu/packages/w3m.scm b/gnu/packages/w3m.scm index b88bbd39bb..1ec07675ab 100644 --- a/gnu/packages/w3m.scm +++ b/gnu/packages/w3m.scm @@ -2,7 +2,7 @@ ;;; Copyright © 2013 Nikita Karetnikov <nikita@karetnikov.org> ;;; Copyright © 2016, 2017, 2018 Leo Famulari <leo@famulari.name> ;;; Copyright © 2016 Kei Kebreau <kkebreau@posteo.net> -;;; Copyright © 2016 Efraim Flashner <efraim@flashner.co.il> +;;; Copyright © 2016, 2019 Efraim Flashner <efraim@flashner.co.il> ;;; Copyright © 2018 Rutger Helling <rhelling@mykolab.com> ;;; ;;; This file is part of GNU Guix. @@ -76,8 +76,8 @@ (home-page "http://w3m.sourceforge.net/") (synopsis "Text-mode web browser") (description - "w3m is a text-based web browser as well as a pager like 'more' or -'less'. With w3m you can browse web pages through a terminal emulator + "w3m is a text-based web browser as well as a pager like @code{more} or +@code{less}. With w3m you can browse web pages through a terminal emulator window. Moreover, w3m can be used as a text formatting tool which typesets HTML into plain text.") (license (x11-style "file://doc/README" diff --git a/gnu/packages/web.scm b/gnu/packages/web.scm index c215c1928f..6a34c1e2fd 100644 --- a/gnu/packages/web.scm +++ b/gnu/packages/web.scm @@ -10,7 +10,7 @@ ;;; Copyright © 2015 Eric Dvorsak <eric@dvorsak.fr> ;;; Copyright © 2016 Sou Bunnbu <iyzsong@gmail.com> ;;; Copyright © 2016 Jelle Licht <jlicht@fsfe.org> -;;; Copyright © 2016, 2017, 2018 Efraim Flashner <efraim@flashner.co.il> +;;; Copyright © 2016, 2017, 2018, 2019 Efraim Flashner <efraim@flashner.co.il> ;;; Copyright © 2016 Rene Saavedra <rennes@openmailbox.org> ;;; Copyright © 2016 Ben Woodcroft <donttrustben@gmail.com> ;;; Copyright © 2016 Clément Lassieur <clement@lassieur.org> @@ -2900,7 +2900,7 @@ fields in the request.") (home-page "https://metacpan.org/release/HTTP-Parser") (synopsis "Parse HTTP/1.1 requests") (description "This is an HTTP request parser. It takes chunks of text as -received and returns a 'hint' as to what is required, or returns the +received and returns a @code{hint} as to what is required, or returns the HTTP::Request when a complete request has been read. HTTP/1.1 chunking is supported.") (license l:perl-license))) @@ -3467,7 +3467,7 @@ required.") (synopsis "Supports app to run as a reverse proxy backend") (description "Plack::Middleware::ReverseProxy resets some HTTP headers, which are changed by reverse-proxy. You can specify the reverse proxy address -and stop fake requests using 'enable_if' directive in your app.psgi.") +and stop fake requests using @code{enable_if} directive in your app.psgi.") (license l:perl-license))) (define-public perl-plack-test-externalserver diff --git a/gnu/packages/xorg.scm b/gnu/packages/xorg.scm index a396586638..770aa9409c 100644 --- a/gnu/packages/xorg.scm +++ b/gnu/packages/xorg.scm @@ -6,7 +6,7 @@ ;;; Copyright © 2015 Eric Dvorsak <eric@dvorsak.fr> ;;; Copyright © 2016 Mathieu Lirzin <mthl@gnu.org> ;;; Copyright © 2015 Cyrill Schenkel <cyrill.schenkel@gmail.com> -;;; Copyright © 2016, 2017 Efraim Flashner <efraim@flashner.co.il> +;;; Copyright © 2016, 2017, 2019 Efraim Flashner <efraim@flashner.co.il> ;;; Copyright © 2016 ng0 <ng0@n0.is> ;;; Copyright © 2016 Alex Kost <alezost@gmail.com> ;;; Copyright © 2016 David Craven <david@craven.ch> @@ -548,7 +548,7 @@ Resources file.") (synopsis "Xorg font aliases") (description "This package provides some common aliases for Xorg fonts. -For example: '6x10', '9x15bold', etc.") +For example: @code{6x10}, @code{9x15bold}, etc.") (license license:x11))) @@ -1600,8 +1600,8 @@ input from UTF-8 into the locale's encoding.") (home-page "https://www.x.org/wiki/") (synopsis "Create an index of scalable font files for X server") (description - "MkFontScale creates the 'fonts.scale' and 'fonts.dir' index files used -by the legacy X11 font system.") + "MkFontScale creates the @code{fonts.scale} and @code{fonts.dir} index +files used by the legacy X11 font system.") (license license:x11))) @@ -2220,7 +2220,7 @@ X11 Inter-Client Communication Conventions Manual (ICCCM).") (synopsis "Default Xorg cursors") (description "This package provides a default set of cursor themes for the Xorg -X server: 'handhelds', 'redglass' and 'whiteglass'.") +X server: @code{handhelds}, @code{redglass} and @code{whiteglass}.") (license license:x11))) @@ -3864,7 +3864,7 @@ extension to the X11 protocol. It includes: "xkeyboard-config provides a database for X Keyboard (XKB) Extension. There are five components that define a complete keyboard mapping: symbols, geometry, keycodes, compat, and types; these five components -can be combined together using the 'rules' component of this database.") +can be combined together using the @code{rules} component of this database.") (license license:x11))) @@ -4746,7 +4746,7 @@ protocol and arbitrary X extension protocol.") (home-page "https://www.x.org/wiki/") (synopsis "Create an index of X font files in a directory") (description - "MkFontDir creates the 'fonts.dir' files needed by the legacy X + "MkFontDir creates the @code{fonts.dir} files needed by the legacy X server core font system. The current implementation is a simple wrapper script around the mkfontscale program.") (license license:x11))) @@ -5680,7 +5680,7 @@ The XCB util-wm module provides the following libraries: (description "The xinit program is used to start the X Window System server and a first client program on systems that are not using a display manager such as -xdm. This package also provides the 'startx' command, which provides a +xdm. This package also provides the @code{startx} command, which provides a user-friendly mechanism to start the X server.") (license license:x11))) |