From: Ivan Maidanski Date: Thu, 18 May 2017 08:13:24 +0000 (+0300) Subject: Use 'inline code' format for commands in README.md X-Git-Tag: v7.4.6~2 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=af0d517dac9d59f2f42d7a7fa844f40ef69a81c1;p=libatomic_ops Use 'inline code' format for commands in README.md (Cherry-pick commit 015f7a6 from 'master' branch.) * README.md: Quote commands with a grave accent character ("`"); the same for names containing an underscore; reformat text. --- diff --git a/README.md b/README.md index 340aeb0..a13552f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# The atomic_ops library (libatomic_ops) +# The atomic_ops library (`libatomic_ops`) IN NEW CODE, PLEASE USE C11 OR C++14 STANDARD ATOMICS INSTEAD OF THIS PACKAGE. @@ -40,29 +40,30 @@ Please address bug reports to [mailing list](mailto:bdwgc@lists.opendylan.org). ## Installation and Usage The configuration and build scripts for this package were generated by -Automake/Autoconf. "./configure; make; sudo make install" in this +Automake/Autoconf. `./configure; make; sudo make install` in this directory should work. For a more customized build, see the output of -"./configure --help". +`./configure --help`. Note that much of the content of this library is in the header files. However, two small libraries are built and installed: -* libatomic_ops.a is a support library, which is not needed on some platforms. - This is intended to be usable, under some mild restrictions, in free or - proprietary code, as are all the header files. See doc/LICENSING.txt. +* `libatomic_ops.a` is a support library, which is not needed on some + platforms. This is intended to be usable, under some mild restrictions, + in free or proprietary code, as are all the header files. + See doc/LICENSING.txt. -* libatomic_ops_gpl.a contains some higher level facilities. This code is +* `libatomic_ops_gpl.a` contains some higher level facilities. This code is currently covered by the GPL. The contents currently correspond to - the headers atomic_ops_stack.h and atomic_ops_malloc.h. + the headers `atomic_ops_stack.h` and `atomic_ops_malloc.h`. ## Platform Specific Notes Win32/64: src/Makefile.msft contains a very simple Makefile for building -and running tests and building the gpl library. The core atomic_ops +and running tests and building the gpl library. The core `libatomic_ops` implementation is entirely in header files. -HP-UX/PA-RISC: aCC -Ae won't work as a C compiler, since it doesn't support +HP-UX/PA-RISC: `aCC -Ae` won't work as a C compiler, since it doesn't support inline assembly code. Use cc.