[GNUnet-SVN] [gnunet] 03/04: fixed typos, improved ascension documentation

[gnunet]

This is an automated email from the git hooks/post-receive script.

rexxnor pushed a commit to branch master
in repository gnunet.

commit d91f5dcc352b6116e346c2a45edfd72ed4de3f9a
Author: rexxnor <address@hidden>
AuthorDate: Sun Jan 20 15:03:24 2019 +0100

    fixed typos, improved ascension documentation
---
 doc/handbook/chapters/developer.texi    | 27 +++++++++++++--------------
 doc/handbook/chapters/installation.texi | 10 ++++++++--
 doc/handbook/chapters/user.texi         |  8 +++-----
 3 files changed, 24 insertions(+), 21 deletions(-)

diff --git a/doc/handbook/chapters/developer.texi 
b/doc/handbook/chapters/developer.texi
index af3ac0197..1d3e1d3fb 100644
--- a/doc/handbook/chapters/developer.texi
+++ b/doc/handbook/chapters/developer.texi
@@ -8079,11 +8079,8 @@ This includes some of well known utilities, like "ping" 
and "nslookup".
 
 @c %**end of header
 
-This section will mainly comprise of the challenges and problems faced when
-writing the ascension tool.
-
-When considering to migrate existing into GNS there are a few things to
-consider.
+This section discusses the challenges and problems faced when writing the
+ascension tool. It also takes a look at possible improvements in the future.
 
 @menu
 * Conversions between DNS and GNS::
@@ -8095,19 +8092,16 @@ consider.
 @subsubsection Conversions between DNS and GNS
 
 The differences between the two name systems lies in the details
-and is not visible from the start. For instance an SRV record is converted to a
+and is not always transparent. For instance an SRV record is converted to a
 gnunet only BOX record.
 
-This is done by building a BOX record from an existing SRV record:
+This is done by converting to a BOX record from an existing SRV record:
 
 @example
+# SRV
 # _service._proto.name. TTL class SRV priority weight port target
 _sip._tcp.example.com. 14000 IN        SRV     0 0 5060 www.example.com.
address@hidden example
-
-Which can be transformed to a GNS BOX record by converting it like this:
-
address@hidden
+# BOX
 # TTL BOX flags port protocol recordtype priority weight port target
 14000 BOX n 5060 6 33 0 0 5060 www.example.com
 @end example
@@ -8137,7 +8131,7 @@ gnunet-namestore -z example.com -n mail -R 3600 MX n 
10,mail
 @end example
 
 Finally, one of the biggest struggling points was the NS records that are found
-in top level domain zones. The inteded behaviour for those is to add GNS2DNS
+in top level domain zones. The intended behaviour for those is to add GNS2DNS
 records for the zone so that gnunet-gns can resolve the for those domain on 
it's
 own. Also a very important aspect of this is, that gnunet needs to be able to
 resolve the nameservers from it's own database. This requires migration of the
@@ -8167,6 +8161,11 @@ resolvable even if they expired. However this would 
introduce the problem of how
 to detect if a record has been removed from the zone and would require deletion
 of said record(s).
 
+Another problem that still persists is how to refresh records. Expired records
+are still displayed when calling gnunet-namestore but do not resolve with
+gnunet-gns. When doing incremental zone transfers this becomes especially
+apparent.
+
 @node Performance
 @subsubsection Performance
 The performance when migrating a zone using the ascension tool is limited by a
@@ -8178,7 +8177,7 @@ resource heavy and was optimized during development by 
adding the '-R'
 at once using the CLI.
 
 The result of this was a much faster migration of TLD zones, as most records
-with the same label have two nameservers.
+with the same label have two name servers.
 
 Another improvement that could be made is with the addition of multiple threads
 when opening the gnunet CLI tools. This could be implemented by simply creating
diff --git a/doc/handbook/chapters/installation.texi 
b/doc/handbook/chapters/installation.texi
index 9a64feef7..bdff20802 100644
--- a/doc/handbook/chapters/installation.texi
+++ b/doc/handbook/chapters/installation.texi
@@ -1698,7 +1698,11 @@ configured proxy) should give you a valid SSL 
certificate for
 @subsubsection Migrating existing DNS zones into GNS
 
 To migrate an existing zone into GNS use the ascension tool.
-You can find the source code here: @code{}
+
+Ascension transfers entire zones into GNS by doing incremental zone transfers
+and then adding the records to GNS.
+
+You can find the source code here: @code{https://gnunet.org/git/ascension.git/}
 
 The software can be installed into a python virtual environment like this:
 @example
@@ -1712,7 +1716,9 @@ Or installed globally like this (not recommended):
 $ sudo python3 setup.py install
 @end example
 
-The advantage of using a virtual environment is, that all the dependencies can 
be installed separately in different versions without touching your existing 
python installation and their dependencies.
+The advantage of using a virtual environment is, that all the dependencies can
+be installed separately in different versions without touching your existing
+python installation and its dependencies.
 
 Using the tool is discussed in the user section of the documentation.
 
diff --git a/doc/handbook/chapters/user.texi b/doc/handbook/chapters/user.texi
index 76d39b50e..a659be9a3 100644
--- a/doc/handbook/chapters/user.texi
+++ b/doc/handbook/chapters/user.texi
@@ -1916,17 +1916,15 @@ Options:
     -v --version    Show version.
 @end example
 
-To migrate the Syrian top level domain - one of the few top level domains that 
still support zone transfers - use the following command:
+To migrate the Syrian top level domain - one of the few top level domains that 
still supports zone transfers - use the following command:
 
 @example
 $ ascension sy. -ns ns1.tld.sy.
 @end example
 
-This will take a while but after it has finished executing the zone will have 
been migrated into GNS.
+The program will continue to run as a daemon and update once the refresh time 
specified in the zones SOA record has elapsed.
 
-The program will continue to run daemon and update once the refresh time 
specified in the zones SOA record has elapsed.
-
-At this point it is trivial to write for example a systemd unit file and to 
enable the service, so that your zone is migrated periodically.
+At this point you might want to write for example a systemd unit file to start 
and enable the service, so that your zone is migrated automatically.
 
 @node re@:claim Identity Provider
 @section re@:claim Identity Provider

-- 
To stop receiving notification emails like this one, please contact
address@hidden