Commit Graph

79 Commits

Author SHA1 Message Date
Zach Bjornson
ed128ef397
doc: add %p to valgrind log-file arg
Since the tests fork processes, a single log file
is largely unreadable.

PR-URL: https://github.com/libuv/libuv/pull/2383
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2019-08-06 10:48:41 -04:00
Leon Huang
87a116c4d0 doc: update the cmake testing instruction
PR-URL: https://github.com/libuv/libuv/pull/2253
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2019-04-22 16:20:20 +02:00
Ben Noordhuis
1a33dcb11b
build: add android-configure scripts to EXTRA_DIST
Commit baa81465a ("build: add compile for android arm64/x86/x86-64")
introduced a number of new android-configure scripts but didn't add
them to EXTRA_DIST in Makefile.am, causing `make dist` to fail.

This commit also removes checkspare.sh from EXTRA_DIST. I broke that
in commit a7a16219d ("unix: remove checksparse.sh") from last June.
Mea culpa!

Fixes: https://github.com/libuv/libuv/issues/2190
PR-URL: https://github.com/libuv/libuv/pull/2198
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2019-03-16 12:34:10 -04:00
Rick
f1981d74ba doc: replace deprecated build command on macOS
Origin README about build command is not suited for current code.

1. gyp_uv.py generated uv.xcodeproj file in directory 'out' instead of
   repository root directory

2. xcode build target params use '-alltargets' instead of '-target All'.

PR-URL: https://github.com/libuv/libuv/pull/2095
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Refael Ackermann <refack@gmail.com>
2018-11-27 16:38:10 +01:00
Andy Zhang
baa81465ad build: add compile for android arm64/x86/x86-64
Add compile options for Android arm64/x86/x86-64 and update the
instructions in README.md.

PR-URL: https://github.com/libuv/libuv/pull/1934
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2018-09-17 12:47:13 +02:00
Jamie Davis
c0c672e1a0
doc: notes on running tests, benchmarks, tools
PR-URL: https://github.com/libuv/libuv/pull/1971
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
2018-09-03 14:55:10 +02:00
Michał Kozakiewicz
43138eefae
doc: update Visual C++ Build Tools URL
Fixes: https://github.com/libuv/libuv/issues/1918
PR-URL: https://github.com/libuv/libuv/pull/1919
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2018-08-11 13:26:54 -04:00
Ben Noordhuis
1a0f619530 build: add test suite option to cmake build
PR-URL: https://github.com/libuv/libuv/pull/1850
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2018-06-14 18:42:51 +02:00
John Barboza
ff167ea5db
zos,doc: add system V message queue note
System V message queues will get left behind on z/OS if uv_loop_t
objects are not closed via uv_loop_close.

PR-URL: https://github.com/libuv/libuv/pull/1823

Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2018-04-29 05:51:29 -04:00
Jamie Davis
f60713f7cf
doc: README: add note on installing gyp
Problem:
The instructions assume you have already installed gyp to
build/gyp.

If you run 'make' without doing so, it asks you to read the README,
which does not actually tell you about installing gyp.

Solution:
Add a one-liner `git clone` command to the setup instructions.

PR-URL: https://github.com/libuv/libuv/pull/1712
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2018-02-28 22:29:00 +01:00
Saúl Ibarra Corretgé
cf6d047e84 doc: update instructions for building on Android
PR-URL: https://github.com/libuv/libuv/pull/1441
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2017-07-27 00:46:02 +02:00
Refael Ackermann
80d3b95f57 doc: format README
PR-URL: https://github.com/libuv/libuv/pull/1284
Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2017-07-04 22:40:14 +02:00
Refael Ackermann
0953bf0dad doc: add instructions for building on Windows
PR-URL: https://github.com/libuv/libuv/pull/1284
Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2017-07-04 22:38:27 +02:00
Saúl Ibarra Corretgé
2ce5734d76 doc: remove ubvook reference from README
PR-URL: https://github.com/libuv/libuv/pull/1246
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
2017-04-28 11:16:09 +02:00
Saúl Ibarra Corretgé
ed76c055cd doc: change license to CC BY 4.0
Text taken from:
https://creativecommons.org/licenses/by/4.0/legalcode.txt

Fixes: https://github.com/libuv/libuv/issues/1254
PR-URL: https://github.com/libuv/libuv/pull/1246
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
2017-04-28 11:15:59 +02:00
Ben Noordhuis
8fd1e40606 doc: add link to libuv/help to README
PR-URL: https://github.com/libuv/libuv/pull/1309
Refs: https://github.com/libuv/libuv/issues/1305
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2017-04-18 17:30:04 +02:00
Saúl Ibarra Corretgé
79e80e0f12 doc: add ABI tracker link to README
PR-URL: https://github.com/libuv/libuv/pull/1053
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Fedor Indutny <fedor@indutny.com>
2016-09-18 10:10:24 +02:00
Saúl Ibarra Corretgé
be0e24c1e8 doc: add supported platforms description
Closes: https://github.com/libuv/libuv/issues/983
PR-URL: https://github.com/libuv/libuv/pull/991
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2016-08-12 22:48:06 +01:00
Saúl Ibarra Corretgé
8b3176933d doc: add licensing information to README
PR-URL: https://github.com/libuv/libuv/pull/887
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Fedor Indutny <fedor@indutny.com>
2016-05-28 12:55:58 +02:00
Saúl Ibarra Corretgé
341097403d doc: add ability to live reload and regenerate HTML
PR-URL: https://github.com/libuv/libuv/pull/819
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2016-04-11 12:52:59 -03:00
Saúl Ibarra Corretgé
2543f56406 doc: add missing link in README
PR-URL: https://github.com/libuv/libuv/pull/722
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2016-02-15 09:57:21 +01:00
Saúl Ibarra Corretgé
67e22296d7 doc: describe how to make release builds on Unix
Refs: https://github.com/libuv/libuv/issues/550
PR-URL: https://github.com/libuv/libuv/pull/722
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2016-02-15 09:56:56 +01:00
Angel Leon
f3216246a2 doc: fix typo in README
PR-URL: https://github.com/libuv/libuv/pull/598
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2015-11-04 21:55:28 +01:00
Saúl Ibarra Corretgé
4bfaaff864 doc: add note about Windows binaries to the README 2015-08-05 22:34:25 +02:00
Saúl Ibarra Corretgé
dbca917bad doc: document the procedure for verifying releases
Refs: https://github.com/libuv/libuv/issues/409
2015-08-05 22:34:25 +02:00
Andrew Paprocki
bb2632b339 aix: add ahafs autoconf detection and README notes
The libuv filesystem events API on AIX requires the non-default IBM
`bos.ahafs` package to be installed.  The library should still compile
and work on systems without this package.  This patch adds proper
detection to `configure.ac` and makes the API return `-ENOSYS` at
runtime if the system does not support it.

PR-URL: https://github.com/libuv/libuv/pull/372
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2015-05-28 11:16:00 +02:00
Devchandra Meetei Leishangthem
2eb1c18240 build: add documentation for ninja support
PR-URL: https://github.com/libuv/libuv/pull/290
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2015-03-26 15:45:09 +01:00
Saúl Ibarra Corretgé
508cd3c220 doc: clarify that we don't maintain external doc resources
PR-URL: https://github.com/libuv/libuv/pull/284
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2015-03-23 10:56:40 +01:00
Stephen von Takach
5abb33dd7b build: update the location of gyp
Google moved the repository

PR-URL: https://github.com/libuv/libuv/pull/240
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2015-03-03 10:13:14 +01:00
Saúl Ibarra Corretgé
e7895debea doc: update README with IRC channel
PR-URL: https://github.com/libuv/libuv/pull/26
2014-12-03 12:03:49 +01:00
Joey Geralnik
45c7ccce21 doc: fix spelling
Fix various typos and spelling mistakes in the documentation

PR-URL: https://github.com/libuv/libuv/pull/17
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2014-11-29 04:22:56 +01:00
Ben Noordhuis
7ce1113885 doc,build,include: update project links
The project home has moved from https://github.com/joyent/libuv to
https://github.com/libuv/libuv.  Update the links inside the repo.
2014-11-25 15:39:12 +01:00
Elijah Andrews
156069130f readme: remove Rust from users
Closes #1572
2014-11-20 19:40:35 +01:00
Ben Noordhuis
f914721c24 build: add x32 support to gyp build
This commit adds x32 support to the gyp build.  Configure with:

    $ ./gyp_uv.py -Dtarget_arch=x32
2014-11-10 20:12:22 -03:00
Thorsten Lorenz
3f585626a4 doc: add learnuv workshop to README 2014-11-06 19:25:42 -05:00
Mikhail Mukovnikov
41ddd1f267 doc: mention homebrew in README 2014-11-06 19:22:35 -05:00
Emmanuel Odeke
b174a84e39 doc: fix git/svn url for gyp repo in README 2014-10-26 07:44:57 -03:00
Jeff Widman
471e844793 doc: fix punctuation and grammar in README 2014-10-06 09:03:25 +02:00
Saúl Ibarra Corretgé
95797f48e8 doc: mention API documentation in README 2014-09-11 09:38:35 +02:00
Saúl Ibarra Corretgé
49ec7ca213 doc: update README with versioning information 2014-08-29 10:32:16 +02:00
Saúl Ibarra Corretgé
645e2a2855 doc: update link to pyuv in README 2014-07-27 12:33:02 +02:00
Saúl Ibarra Corretgé
06c60e9662 doc: add logo image to README 2014-07-20 19:38:46 +02:00
Jay Satiro
90e4afd4fa windows: fix PYTHON environment variable usage
- (README.md) The PYTHON environment variable should point to python.exe
not the python directory.

- (vcvars.bat) The PYTHON environment variable should be quoted on
expansion in case there's spaces in the path.
2014-06-11 23:01:32 +02:00
Saúl Ibarra Corretgé
a442aa7643 doc: small fixes to comments and syntax 2014-02-23 18:01:03 +01:00
Nathan Sweet
acb9f8951e doc: adding ARCHS flag to OS X build command
Adding further instructions about building for OS X, as recent versions
of xcodebuild will automatically build for i386 (can someone say,
"monoculture") even on x86_64 machines! Specifically including
instructions about including the "ARCHS" flag to specify the right
architecture.

This is trivial, but will save people time.
2014-01-13 17:43:25 +00:00
Saúl Ibarra Corretgé
7d23c1d7b9 doc: add libuv-dox to the documentation section 2013-12-27 13:17:56 +01:00
Andrius Bentkus
20253414c3 doc: add readme link to all projects that use libuv. 2013-12-25 20:42:58 +02:00
Maciej Małecki
8094ac2129 doc: document how to run tests 2013-12-05 14:56:53 +04:00
Tenor Biel
2e58ea8fd5 doc: fixed typo in readme
The link to nodejs.org in README.md was broken.
2013-11-30 20:21:39 -08:00
Bert Belder
39db22594d doc: add guidelines for contributing 2013-12-01 03:23:18 +01:00