Commit c95bb951 authored by Jan Včelák's avatar Jan Včelák 🚀

global whitespace cleanup

Change-Id: I429b3833c5db9e78220beb1ea72980b557ba06c4
parent b533e885
......@@ -43,15 +43,15 @@ Doxygen
Example
=======
/*!
/*!
* \brief Some structure.
*
*
* Longer description.
*/
struct some_struct {
/*!
* \brief This comment does not fit on the same line as the member
* as it is rather large.
* as it is rather large.
*/
int fd;
int flags; /*!< Flags. */
......@@ -61,7 +61,7 @@ Example
* \brief Brief description of some function.
*
* Longer description.
*
*
* \note This function is deprecated.
*
* \warning Do not use this function!
......@@ -69,7 +69,7 @@ Example
* \param param1 Some parameter.
* \param param2 Other parameter. This one has rather large comment,
* so its next line is indented for better readability.
*
*
* \retval 0 on success.
* \retval -1 if some error occured.
*
......
This source diff could not be displayed because it is too large. You can view the blob instead.
This source diff could not be displayed because it is too large. You can view the blob instead.
......@@ -67,7 +67,7 @@ $ sudo make install
$ sudo ldconfig
Alternative packages for I386:
$ # the required version of liburcu is not available in the default package
$ # the required version of liburcu is not available in the default package
$ # sources.
$
$ wget http://bd.archive.ubuntu.com/ubuntu/pool/universe/libu/liburcu/liburcu0_0.5.4-1_i386.deb
......@@ -142,7 +142,7 @@ Prerequisites:
$ mkdir liburcu && cd liburcu
$ wget "http://lttng.org/files/urcu/userspace-rcu-0.6.7.tar.bz2"
$ patch -p1 < ../scripts/urcu-tls-compat.patch
$ patch -p1 < ../scripts/urcu-tls-compat.patch
$ autoconf && ./configure && make && sudo make install
$ # or follow installation instructions in INSTALL
......@@ -160,13 +160,13 @@ Not all prerequisites are preinstalled for OS X.
- liburcu >= 0.7.0 works with supplied compiler, however ARCH must still be set
- alternative is to set it with configure parameter --target
Compiling Knot DNS with gcc-mp-4.6 is recommended, but not necessary.
Compiling Knot DNS with gcc-mp-4.6 is recommended, but not necessary.
Running
=======
First, each server needs configuration file.
Please see samples/knot.sample.conf for reference.
First, each server needs configuration file.
Please see samples/knot.sample.conf for reference.
Minimal configuration can be found in samples/knot.min.conf
Configuration zone has to specify:
* storage for PID files, compiled zones etc.
......@@ -192,11 +192,10 @@ Running as daemon
Controller runs server in daemonized mode as default. Disadvantage is, that
it closes stdout/stderr so you need to set up either syslog or logging to
own files in the configuration. Controller parameter '-w' waits for the
own files in the configuration. Controller parameter '-w' waits for the
operation to finish. Let's test server functionality.
$ knotc -c myserver.conf -w start # start server
$ dig @$ADDR -p $PORT example.com # issue a query and see result
$ ...
$ knotc -c myserver.conf -w stop # stop server
......@@ -32,7 +32,7 @@ v1.2.0-rc2 - Feb 15, 2013
Bugfixes:
* Fixed processing of some non-standard dnames.
* Correct checking of label length bounds in some cases.
* Correct checking of label length bounds in some cases.
* More compliant rcodes in case of DDNS/TSIG failures.
* Correct processing of malformed DDNS prereq section.
......@@ -55,7 +55,7 @@ v1.1.3-rc1 - Dec 6, 2012
------------------------
Bugfixes:
* Fixed answering DS queries (RRSIGs not together with DS, AA bit
* Fixed answering DS queries (RRSIGs not together with DS, AA bit
missing).
* Fixed setting ARCOUNT in some error responses with EDNS enabled.
* Fixed crash when compiling zone zone with NSEC3PARAM but no NSEC3
......@@ -89,17 +89,17 @@ v1.1.1-rc1 - Oct 23, 2012
Bugfixes:
* Crash after IXFR in certain cases when adding RRSIG in an IXFR.
* Fixed behaviour when incoming IXFR removes a zone cut. Previously
occluded names now become properly visible. Previously lead to a
* Fixed behaviour when incoming IXFR removes a zone cut. Previously
occluded names now become properly visible. Previously lead to a
crash when the server was asked for the previously occluded name.
* Fixed handling of zero-length strings in text zone dump. Caused the
* Fixed handling of zero-length strings in text zone dump. Caused the
compilation to fail.
* Fixed TSIG algorithm name comparison - the names should be in
* Fixed TSIG algorithm name comparison - the names should be in
canonical form.
* Fixed handling unknown RR types with type less than 251.
Features:
* Improved compression of packets. Out-of-zone dnames present in RDATA
* Improved compression of packets. Out-of-zone dnames present in RDATA
were not compressed.
* Slave zones are now automatically refreshed after startup.
* Proper response to IXFR/UDP query (returns SOA in Authority section).
......@@ -122,7 +122,7 @@ New features:
* Signing SOA with TSIG queries when checking zone version with master.
Bugfixes:
* Fixed ixfr-from-differences journal generation in case of IPSECKEY
* Fixed ixfr-from-differences journal generation in case of IPSECKEY
and APL records.
* Fixed possible leak on server shutdown with a pending transfer.
......@@ -142,7 +142,7 @@ New features:
* Following DNAME if the synthetized name is in the same zone.
Bugfixes:
* Crash when zone contained RRSIG signing a CNAME, but did not
* Crash when zone contained RRSIG signing a CNAME, but did not
contain the CNAME.
* Malformed packets parsing.
* Failed IXFR caused memory leaks.
......@@ -153,10 +153,10 @@ Bugfixes:
* Handling RRSets with different TTLs - TTL from the first RR is used.
* Synchronization of zone reload and zone transfers.
* Fixed build on NetBSD 5 and FreeBSD.
* Fixed binding to both IPv4 and IPv6 at the same time on special
* Fixed binding to both IPv4 and IPv6 at the same time on special
interfaces.
* Fixed access rights of created files.
* Semantic checks corrupted RDATA domain names which are covered by
* Semantic checks corrupted RDATA domain names which are covered by
wildcard in the same zone.
Other improvements:
......@@ -165,7 +165,7 @@ Other improvements:
* More detailed log messages (mostly transfer-related).
* Copying Question section to error responses.
* Using zone name from config file as default origin in zone file.
* Additional records are now added to response also from
* Additional records are now added to response also from
wildcard-covered names.
v1.0.6 - Jun 13, 2012
......@@ -191,16 +191,16 @@ New features:
* RFC3339-complaint format of log time.
* Support for TLSA (RR type 52).
* knotc checkzone (as a dry-run of zone compile).
* knotc refresh for forcing Knot to update all zones from master
* knotc refresh for forcing Knot to update all zones from master
servers.
* Reopening log files upon start (used to truncate them).
Bugfixes:
* Copying OPCODE and RD bit from query to NOTIMPL responses.
* Corrected response to CNAME queries if the canonical name was also
* Corrected response to CNAME queries if the canonical name was also
an alias (was adding the whole CNAME chain to the response).
* Fixed crash when NS or MX points to an alias.
* Fixed problem with early closing of filedescriptors (lead to crash
* Fixed problem with early closing of filedescriptors (lead to crash
when compiling and loading or bootstrapping and restarting the server
with a lot of zones).
......@@ -281,7 +281,7 @@ New features:
* CNAME loop detection.
* Timeout on TCP connections.
* Basic defense against DoS attacks.
Bugfixes:
* Fixed IXFR processing.
* Patched URCU so that it compiles on architectures without TLS in compiler (NetBSD, OpenBSD).
......@@ -312,10 +312,10 @@ New features:
* Use of sendmmsg() on Linux 3.0+ (improves performance).
Bugfixes:
* Knot was not accepting AXFR-style IXFR with first SOA in a separate
* Knot was not accepting AXFR-style IXFR with first SOA in a separate
packet (i.e. from Power DNS).
* Wrong SOA TTL in negative answers.
* Wrong max packet size for outgoing transfers (was causing the
* Wrong max packet size for outgoing transfers (was causing the
packets to be malformed).
* Wrong handling of WKS record in zone compiler.
* Problems with zone bootstrapping.
......
......@@ -9,4 +9,3 @@
--align-pointer=name
--mode=c
--lineend=linux
......@@ -4,12 +4,12 @@
In this chapter we provide suggested configurations and explain the meaning of individual configuration options.
@menu
* Minimal configuration::
* Slave configuration::
* Master configuration::
* Configuring multiple interfaces::
* Minimal configuration::
* Slave configuration::
* Master configuration::
* Configuring multiple interfaces::
* Using DNS UPDATE::
* Remote control interface::
* Remote control interface::
* Enabling zone semantic checks::
* Creating IXFR differences from zone file changes::
* Using Response Rate Limiting::
......@@ -43,21 +43,21 @@ log @{
@}
zones @{
example.com @{
example.com @{
file "/etc/knot/example.com";
@}
@}
@end example
@page
Now let's go step by step through this minimal configuration file:
@enumerate
@enumerate
@item
In @code{system} statement we have configured @code{storage}
directory where Knot DNS will store compiled zone files,
directory where Knot DNS will store compiled zone files,
PID file and for slave zone also their journal files. (See @ref{system} and @ref{storage})
@item
......@@ -103,7 +103,7 @@ remotes @{
subnet1 @{ address 192.168.1.0/24; @}
@}
zones @{
example.com @{
example.com @{
file "example.com"; # relative to 'storage'
xfr-in master; # define 'master' for this zone
notify-in master; # also allow NOTIFY from 'master'
......@@ -127,7 +127,7 @@ remotes @{
master @{ address 127.0.0.1@@53; key key0; @}
@}
zones @{
example.com @{
example.com @{
file "example.com"; # relative to 'storage'
xfr-in master; # define 'master' for this zone
notify-in master; # also allow NOTIFY from 'master'
......@@ -151,7 +151,7 @@ remotes @{
subnet2 @{ address 192.168.2.0/8; @}
@}
zones @{
example.com @{
example.com @{
file "/var/zones/example.com";
xfr-out subnet1, subnet2; # allow outgoing transfers
notify-out slave;
......@@ -170,7 +170,7 @@ remotes @{
any @{ address 0.0.0.0/0; key key0; @}
@}
zones @{
example.com @{
example.com @{
file "/var/zones/example.com";
xfr-out any; # uses 'any' remote secured with TSIG key 'key0'
@}
......@@ -195,7 +195,7 @@ interfaces @{
As noted in examples for master and slave, it is possible to accept DNS UPDATE messages.
When the zone is configured as a slave and DNS UPDATE messages is accepted, server forwards the
message to its primary master specified by @code{xfr-in} directive. When it receives
message to its primary master specified by @code{xfr-in} directive. When it receives
the response from primary master, it forwards it back to the originator. This finishes the transaction.
However, if the zone is configured as master (i.e. not having any @code{xfr-in} directive), it accepts
......@@ -238,7 +238,7 @@ remotes @{
control @{
listen-on @{ address 127.0.0.1; @}
allow ctl;
@}
@}
@end example
The @code{allow} keyword accepts an ACL list, similar to @code{xfr-in} or @code{xfr-out},
......@@ -253,7 +253,7 @@ which checks are enabled by default and which are optional.
@node Creating IXFR differences from zone file changes
@section Creating IXFR differences from zone file changes
If Knot is being run as a master server, experimental feature @code{ixfr-from-differences}
If Knot is being run as a master server, experimental feature @code{ixfr-from-differences}
can be enabled to create IXFR differences from changes made to the master zone file.
See @ref{Controlling running daemon} for more information. For more about @code{zones} statement see @ref{zones}.
......@@ -280,8 +280,6 @@ Example configuration:
@example
system @{
rate-limit 200; # Each flow is allowed to 200 resp. per second
rate-limit-slip 2; # Every other response is slipped (default)
rate-limit-slip 2; # Every other response is slipped (default)
@}
@end example
......@@ -2,10 +2,10 @@
@chapter Knot DNS Installation
@menu
* Required build environment::
* Required libraries::
* Installation from the sources::
* Installation from packages::
* Required build environment::
* Required libraries::
* Installation from the sources::
* Installation from packages::
@end menu
@node Required build environment
......@@ -34,7 +34,7 @@ bison >= 2.3
Knot DNS requires few libraries to be compiled:
@itemize
@itemize
@item
OpenSSL, at least 0.9.8
......@@ -46,7 +46,7 @@ Userspace RCU, at least 0.5.4
libcap-ng, at least 0.6.4 (optional library)
@end itemize
If libcap-ng library is available, Knot DNS will take advantage of
If libcap-ng library is available, Knot DNS will take advantage of
the POSIX 1003.1e capabilites(7) by sandboxing the exposed threads.
Most rights are stripped from the exposed threads for security reasons.
......@@ -56,7 +56,7 @@ your system or distribution. If not, zlib resides at
@url{http://www.openssl.org}.
@menu
* Userspace RCU::
* Userspace RCU::
@end menu
@node Userspace RCU
......@@ -89,9 +89,9 @@ After unpacking the sources, the compilation and installation is
a quite straightforward process using autotools.
@menu
* Configuring and generating Makefiles::
* Compilation::
* Installation::
* Configuring and generating Makefiles::
* Compilation::
* Installation::
@end menu
@node Configuring and generating Makefiles
......@@ -184,10 +184,10 @@ the Knot DNS might already be available in your favourite
distribution, or in a ports tree.
@menu
* Installing Knot DNS packages on Debian::
* Installing Knot DNS packages on Ubuntu::
* Installing Knot DNS packages on Debian::
* Installing Knot DNS packages on Ubuntu::
* Installing Knot DNS packages on Fedora::
* Installing Knot DNS from ports on FreeBSD::
* Installing Knot DNS from ports on FreeBSD::
@end menu
@node Installing Knot DNS packages on Debian
......@@ -218,7 +218,7 @@ deb-src http://deb.knot-dns.cz/debian/ <codename> main
EOF
$ apt-get update
$ apt-get install knot
@end example
@node Installing Knot DNS packages on Ubuntu
......@@ -238,7 +238,7 @@ the time of writing this manual this includes Ubuntu 10.04 LTS, 11.04,
11.10 and 12.04 LTS.
@menu
* Adding official PPA repository for Knot DNS::
* Adding official PPA repository for Knot DNS::
@end menu
@node Adding official PPA repository for Knot DNS
......@@ -253,7 +253,7 @@ the PPA.
$ sudo add-apt-repository ppa:cz.nic-labs/knot-dns
$ sudo apt-get update
$ sudo apt-get install knot
@end example
@noindent
......@@ -313,7 +313,6 @@ following command as the root user:
Knot DNS is in ports tree under @code{dns/knot}.
@example
$ cd /usr/ports/dns/knot
$ cd /usr/ports/dns/knot
$ sudo make install
@end example
......@@ -5,16 +5,16 @@ The reader of this document is assumed to know the principles of
Domain Name System.
@menu
* What is Knot DNS::
* What is Knot DNS::
* Knot DNS features::
* Scope of this document::
* Scope of this document::
@end menu
@node What is Knot DNS
@section What is Knot DNS
Knot DNS is a high-performance open source DNS server. It
implements only authoritative domain name service. Knot DNS
Knot DNS is a high-performance open source DNS server. It
implements only authoritative domain name service. Knot DNS
is best suited for use on TLD domains but can reliably serve
any other zones as well.
......@@ -47,13 +47,13 @@ Server features:
@item Semantic checks of zones
@end itemize
For more info and downloads see
For more info and downloads see
@url{http://www.knot-dns.cz, www.knot-dns.cz}.
Git repository:
Git repository:
@url{git://git.nic.cz/knot-dns.git, git://git.nic.cz/knot-dns.git}
Knot DNS issue tracker:
Knot DNS issue tracker:
@url{https://git.nic.cz/redmine/projects/knot-dns,
git.nic.cz/redmine/projects/knot-dns}
......@@ -65,4 +65,3 @@ Knot DNS users mailing list:
This document covers the basic information on installing,
configuring and troubleshooting the Knot DNS server.
......@@ -59,71 +59,71 @@ This manual is for Knot DNS (version @value{VERSION}, @value{UPDATED}).
@end ifnottex
@menu
* Introduction::
* Knot DNS Resource Requirements::
* Knot DNS Installation::
* Knot DNS Configuration::
* Running Knot DNS::
* Troubleshooting::
* Statement Index::
* Knot DNS Configuration Reference::
* Introduction::
* Knot DNS Resource Requirements::
* Knot DNS Installation::
* Knot DNS Configuration::
* Running Knot DNS::
* Troubleshooting::
* Statement Index::
* Knot DNS Configuration Reference::
@detailmenu
--- The Detailed Node Listing ---
Introduction
* What is Knot DNS::
* What is Knot DNS::
* Knot DNS features::
* Scope of this document::
* Scope of this document::
Knot DNS Resource Requirements
* Hardware requirements::
* CPU requirements::
* Memory requirements::
* Supported operating system::
* Hardware requirements::
* CPU requirements::
* Memory requirements::
* Supported operating system::
Knot DNS Installation
* Required build environment::
* Required libraries::
* Installation from the sources::
* Installation from packages::
* Required build environment::
* Required libraries::
* Installation from the sources::
* Installation from packages::
Required libraries
* Userspace RCU::
* Userspace RCU::
Installation from the sources
* Configuring and generating Makefiles::
* Compilation::
* Installation::
* Configuring and generating Makefiles::
* Compilation::
* Installation::
Installation from packages
* Installing Knot DNS packages on Debian::
* Installing Knot DNS packages on Ubuntu::
* Installing Knot DNS packages on Debian::
* Installing Knot DNS packages on Ubuntu::
* Installing Knot DNS packages on Fedora::
* Installing Knot DNS from ports on FreeBSD::
* Installing Knot DNS from ports on FreeBSD::
Installing Knot DNS packages on Ubuntu
* Adding official PPA repository for Knot DNS::
* Adding official PPA repository for Knot DNS::
Knot DNS Configuration
* Minimal configuration::
* Slave configuration::
* Master configuration::
* Configuring multiple interfaces::
* Minimal configuration::
* Slave configuration::
* Master configuration::
* Configuring multiple interfaces::
Sample Configurations
* Minimal configuration::
* Slave configuration::
* Master configuration::
* Minimal configuration::
* Slave configuration::
* Master configuration::
* Configuring multiple interfaces::
* Enabling zone semantic checks::
* Creating IXFR differences from zone file changes::
......@@ -137,8 +137,8 @@ Running Knot DNS
Troubleshooting
* Submitting a bugreport::
* Generating backtrace::
* Debug messages::
* Generating backtrace::
* Debug messages::
Debug messages
......@@ -150,30 +150,30 @@ Enabling debug messages in server
Knot DNS Configuration Reference
* system::
* keys::
* interfaces::
* remotes::
* system::
* keys::
* interfaces::
* remotes::
* groups::
* zones::
* log::
* zones::
* log::
* include::
@code{system} Statement
* system Syntax::
* system Statement Definition and Usage::
* system Example::
* system Syntax::
* system Statement Definition and Usage::
* system Example::
Statement Definition and Usage
* identity::
* version::
* nsid::
* storage::
* pidfile::
* workers::
* user::
* identity::
* version::
* nsid::
* storage::
* pidfile::
* workers::
* user::
* max-conn-idle::
* max-conn-hs::
* max-conn-reply::
......@@ -183,28 +183,28 @@ Statement Definition and Usage
@code{keys} Statement
* keys Syntax::
* keys Statement Definition and Usage::
* Example::
* keys Syntax::
* keys Statement Definition and Usage::
* Example::
Statement Definition and Usage
* key_id::
* key_id::
interfaces
* interfaces Syntax::
* interfaces Statement Definition and Usage::
* interfaces Examples::
* interfaces Syntax::
* interfaces Statement Definition and Usage::
* interfaces Examples::
Statement Definition and Usage
* interface_id::
* interface_id::
@code{remotes} Statement
* remotes Syntax::
* remotes Statement Definition and Grammar::
* remotes Syntax::
* remotes Statement Definition and Grammar::
@code{groups} Statement
......@@ -213,14 +213,14 @@ Statement Definition and Usage
@code{zones} Statement
* zones Syntax::
* zones Syntax::
* zones Statement Definition and Grammar::
* zones List of zone semantic checks::
@code{log} Statement
* log Syntax::
* log Statement Definition and Grammar::
* log Syntax::
* log Statement Definition and Grammar::
@code{include} Statement
......
......@@ -2,10 +2,10 @@
@appendix Migration for other DNS servers
@menu
* Knot DNS for BIND users::
* Knot DNS for NSD users::
* Knot DNS for PowerDNS users::
* Knot DNS for djbdns users::
* Knot DNS for BIND users::
* Knot DNS for NSD users::
* Knot DNS for PowerDNS users::
* Knot DNS for djbdns users::
@end menu
@node Knot DNS for BIND users
......
......@@ -4,14 +4,14 @@
This reference describes every configuration option in Knot DNS server.
@menu
* system::
* keys::
* interfaces::
* remotes::
* system::
* keys::
* interfaces::
* remotes::
* groups::
* control::
* zones::
* log::
* zones::
* log::
* include::
@end menu