From d72881b87ff9bea0d90bbf6d611acce5fd28bf4a Mon Sep 17 00:00:00 2001 From: Tyson Andre Date: Mon, 13 Nov 2017 21:13:16 -0800 Subject: [PATCH] Spelling nits --- README.md | 21 ++++++++++----------- WINDOWS.md | 4 ++-- 2 files changed, 12 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index a948de1b..859e5917 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ reduction in storage requirement can be expected. Specific number depends on your data. Unserialization performance is at least on par with the standard PHP serializer. -Serialization performance depends on the "compact_strings" option which enables +Serialization performance depends on the `igbinary.compact_strings` option which enables duplicate string tracking. String are inserted to a hash table which adds some overhead. In usual scenarios this does not have much significance since usage pattern is "serialize rarely, unserialize often". With "compact_strings" @@ -48,7 +48,7 @@ Igbinary uses two specific strategies to minimize the size of the serialized output. 1. Repetitive strings are stored only once. Collections of objects benefit - significantly from this. See "compact_strings" option. + significantly from this. See the `igbinary.compact_strings` option. 2. Numerical values are stored in the smallest primitive data type available: @@ -88,16 +88,17 @@ Sometimes phpize must be substituted with phpize5. In such cases the following option must be given to configure script: "--with-php-config=.../php-config5" 1. `phpize` -2. `./configure: +2. `./configure` + - With GCC: `./configure CFLAGS="-O2 -g" --enable-igbinary` - With ICC (Intel C Compiler) `./configure CFLAGS=" -no-prec-div -O3 -xO -unroll2 -g" CC=icc --enable-igbinary` - With clang: `./configure CC=clang CFLAGS="-O0 -g" --enable-igbinary` 3. `make` 4. `make test` 5. `make install` -6. igbinary.so is installed to the default extension directory +6. `igbinary.so` is installed to the default extension directory -### To run APCu test +### To run APCu test cases ``` # go to modules directory @@ -108,7 +109,7 @@ cd modules /opt/lib/php/extensions/no-debug-non-zts-20121212/apcu.so ``` -Similar approach should work for APC. +A similar approach should work for APC. ### Installing on Windows @@ -120,7 +121,7 @@ Bugs & Contributions Mailing list for bug reports and other development discussion can be found at http://groups.google.com/group/igbinary -Fill bug reports at +File bug reports at https://github.com/igbinary/igbinary/issues The preferred ways for contributions are pull requests and email patches @@ -130,7 +131,7 @@ Utilizing in other extensions ----------------------------- Igbinary can be called from other extensions fairly easily. Igbinary installs -its header file to _ext/igbinary/igbinary.h_. There are just two straighforward +its header file to _ext/igbinary/igbinary.h_. There are just two straightforward functions: `igbinary_serialize` and `igbinary_unserialize`. Look at _igbinary.h_ for prototypes and usage. @@ -143,6 +144,4 @@ Trivia Where does the name "igbinary" come from? There was once a similar project called fbinary but it has disappeared from the Internet a long time ago. Its architecture wasn't particularly clean either. IG is an abbreviation for a -finnish social networking site IRC-Galleria (http://irc-galleria.net/) - - +Finnish social networking site IRC-Galleria (http://irc-galleria.net/) diff --git a/WINDOWS.md b/WINDOWS.md index d5ddf3b2..c50cadde 100644 --- a/WINDOWS.md +++ b/WINDOWS.md @@ -44,11 +44,11 @@ Building igbinary See https://wiki.php.net/internals/windows/stepbystepbuild#building\_pecl\_extensions -### Install APCU (optional) +### Install APCu (optional) Note: The Windows build hasn't worked for a while in 5.6, so there may be compilation errors or test failures. -TODO: Make sure that `config.w32` works without APCU installed. +TODO: Make sure that `config.w32` works without APCu installed. > 1. Open the extension's page on PECL ([APCu](https://pecl.php.net/package/APCu)) > 2. Download the extension source either by: