More changes to NEWS, README, INSTALL, & configure.ac
authorWayne Davison <wayne@opencoder.net>
Fri, 24 Jul 2020 18:53:16 +0000 (11:53 -0700)
committerWayne Davison <wayne@opencoder.net>
Fri, 24 Jul 2020 19:38:25 +0000 (12:38 -0700)
INSTALL.md
NEWS.md
README.md
configure.ac

index ef2d2b3a7bed7964172b377a50dc50885a5599a4..93b700af9748f0bd361236a2ae0ee6f04e523288 100644 (file)
@@ -35,32 +35,40 @@ installed to manipulate xattrs and to run the rsync testsuite.
 
 ## xxhash
 
-The [xxHash library](https://cyan4973.github.io/xxHash/) provides extremely
-fast checksum functions that can make the "rsync algorithm" run much more
-quickly, especially when matching blocks in large files.  Installing this
-development library adds xxhash checksums as the default checksum algorithm.
+The [xxHash library][1] provides extremely fast checksum functions that can
+make the "rsync algorithm" run much more quickly, especially when matching
+blocks in large files.  Installing this development library adds xxhash
+checksums as the default checksum algorithm.
+
+[1]: https://cyan4973.github.io/xxHash/
 
 ## zstd
 
-The [zstd library](http://facebook.github.io/zstd/) compression algorithm that
-uses a lot less CPU than the default zlib algorithm at the same compression
-level.  Note that you need at least version 1.4, so you might need to skip the
-zstd compression if you can only install a 1.3 release.  Installing this
-development library adds zstd compression as the default compression algorithm.
+The [zstd library][2] compression algorithm that uses a lot less CPU than
+the default zlib algorithm at the same compression level.  Note that you
+need at least version 1.4, so you might need to skip the zstd compression if
+you can only install a 1.3 release.  Installing this development library
+adds zstd compression as the default compression algorithm.
+
+[2]: http://facebook.github.io/zstd/
 
 ## lz4
 
-The [lz4 library](https://lz4.github.io/lz4/) compression algorithm that uses
-very little CPU, though it also has the smallest compression ratio of other
-algorithms.  Installing this development library adds lz4 compression as an
-available compression algorithm.
+The [lz4 library][3] compression algorithm that uses very little CPU, though
+it also has the smallest compression ratio of other algorithms.  Installing
+this development library adds lz4 compression as an available compression
+algorithm.
+
+[3]: https://lz4.github.io/lz4/
 
 ## openssl crypto
 
-The [openssl crypto library](https://www.openssl.org/docs/man1.0.2/man3/crypto.html)
-provides some hardware accelerated checksum algorithms for MD4 and MD5.
-Installing this development library makes rsync use the (potentially) faster
-checksum routines when computing MD4 & MD5 checksums.
+The [openssl crypto library][4] provides some hardware accelerated checksum
+algorithms for MD4 and MD5.  Installing this development library makes rsync
+use the (potentially) faster checksum routines when computing MD4 & MD5
+checksums.
+
+[4]: https://www.openssl.org/docs/man1.0.2/man3/crypto.html
 
 ## Package summary
 
@@ -188,9 +196,10 @@ Install gcc or HP's "ANSI/C Compiler".
 Some versions of Mac OS X (Darwin) seem to have an IPv6 stack, but do
 not completely implement the "New Sockets" API.
 
-[This site](http://www.ipv6.org/impl/mac.html) says that Apple started to
-support IPv6 in 10.2 (Jaguar).  If your build fails, try again after running
-configure with --disable-ipv6.
+[This site][5] says that Apple started to support IPv6 in 10.2 (Jaguar).  If
+your build fails, try again after running configure with --disable-ipv6.
+
+[5]: http://www.ipv6.org/impl/mac.html
 
 ## IBM AIX notes
 
diff --git a/NEWS.md b/NEWS.md
index 27e8eef80fc6d2d4fc4c650492ea6b90e3edd02a..08cac0435ac02a2468bf1639e221c47344cc2fdb 100644 (file)
--- a/NEWS.md
+++ b/NEWS.md
@@ -39,8 +39,8 @@
    protocol (so if you used this patch in the past, be sure to update your
    converter script to use newlines instead of null chars).
 
- - Added `--crtimes` (`-N`) option for preserving the file's create time (on
-   an OS that supports that, such as macOS).
+ - Added `--crtimes` (`-N`) option for preserving the file's create time (I
+   believe that this is macOS only at the moment).
 
  - Added `--mkpath` option to tell rsync that it should create a non-existing
    path component of the destination arg.
@@ -60,6 +60,8 @@
    error to go from the receiver to the generator to the sender.  To disable
    this new default you can use the `--no-msgs2stderr` option.
 
+ - Change configure to know that Cywin supports Linux xattrs.
+
  - Improved the testsuite on FreeBSD & Cygwin.
 
  - Added some compatibility code for HPE NonStop platforms.
index 4c3894b550c69d1b4d4618d275fd51bd91a56ab6..f9875182ba08a355e37c7d51edc51529b206b49f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -26,6 +26,15 @@ options.  To get a complete list of supported options type:
 See the manpage for more detailed information.
 
 
+BUILDING AND INSTALLING
+-----------------------
+
+If you need to build rsync yourself, check out the [INSTALL][1] page for
+information on what libraries and packages you can use to get the maximum
+features in your build.
+
+[1]: https://download.samba.org/pub/rsync/INSTALL
+
 SETUP
 -----
 
@@ -63,9 +72,9 @@ connect to an rsync daemon.
 WEB SITE
 --------
 
-The main rsync web site is here:
+For more information, visit the [main rsync web site][2].
 
- https://rsync.samba.org/
+[2]: https://rsync.samba.org/
 
 You'll find a FAQ list, downloads, resources, HTML versions of the
 manpages, etc.
@@ -77,25 +86,25 @@ MAILING LISTS
 There is a mailing list for the discussion of rsync and its applications
 that is open to anyone to join.  New releases are announced on this
 list, and there is also an announcement-only mailing list for those that
-want official announcements.  See the mailing-list page for full
-details:
+want official announcements.  See the [mailing-list page][3] for full
+details.
 
- https://rsync.samba.org/lists.html
+[3]: https://rsync.samba.org/lists.html
 
 
 BUG REPORTS
 -----------
 
-To visit this web page for full the details on bug reporting:
+The [bug-tracking web page][4] has full details on bug reporting.
 
->  https://rsync.samba.org/bugtracking.html
+[4]: https://rsync.samba.org/bug-tracking.html
 
-That page contains links to the current bug list, and information on how
-to report a bug well.  You might also like to try searching the Internet
-for the error message you've received, or looking in the mailing list
-archives at:
+That page contains links to the current bug list, and information on how to
+do a good job when reporting a bug.  You might also like to try searching
+the Internet for the error message you've received, or looking in the
+[mailing list archives][5].
 
- https://mail-archive.com/rsync@lists.samba.org/
+[5]: https://mail-archive.com/rsync@lists.samba.org/
 
 To send a bug report, follow the instructions on the bug-tracking
 page of the web site.
@@ -108,18 +117,15 @@ GIT REPOSITORY
 
 If you want to get the very latest version of rsync direct from the
 source code repository, then you will need to use git.  The git repo
-is hosted on github and on samba's site.  Feel free to access it here:
-
->  https://github.com/WayneD/rsync
+is hosted [on GitHub][6] and [on Samba's site][7].
 
-A backup git repo is available on the samba site:
+[6]: https://github.com/WayneD/rsync
+[7]: https://git.samba.org/?p=rsync.git;a=summary
 
->     git clone git://git.samba.org/rsync.git
+See [the download page][8] for full details on all the ways to grab the
+source.
 
-See the download page for full details on all the ways to grab the
-source:
-
->  https://rsync.samba.org/download.html
+[8]: https://rsync.samba.org/download.html
 
 
 COPYRIGHT
@@ -130,13 +136,8 @@ maintained by Wayne Davison.  It has been improved by many developers
 from around the world.
 
 Rsync may be used, modified and redistributed only under the terms of
-the GNU General Public License, found in the file COPYING in this
-distribution, or at:
-
->  https://www.fsf.org/licenses/gpl.html
-
-
-AVAILABILITY
-------------
+the GNU General Public License, found in the file [COPYING][9] in this
+distribution, or at [the Free Software Foundation][10].
 
-The main web site for rsync is https://rsync.samba.org/
+[9]: https://download.samba.org/pub/rsync/COPYING
+[10]: https://www.fsf.org/licenses/gpl.html
index ae6445d1216348f3e61aba28f3a98f03866ccdfe..8030eebcae4f5a9faefd59b5595c97aa2e9f1ec9 100644 (file)
@@ -1,6 +1,6 @@
 dnl Process this file with autoconf to produce a configure script.
 
-AC_INIT([rsync],[ ],[https://rsync.samba.org/bugtracking.html])
+AC_INIT([rsync],[ ],[https://rsync.samba.org/bug-tracking.html])
 
 AC_CONFIG_MACRO_DIR([m4])
 AC_CONFIG_SRCDIR([byteorder.h])