interesting
/
getdns
mirror of https://github.com/getdnsapi/getdns.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

updates to some docs based on our meeting of 2013-11-02

This commit is contained in:
Glen Wiley 2013-11-03 08:47:19 -05:00
parent e3e2247f27
commit 2e1fb7b8b8
2 changed files with 49 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
README.md
View File

@ -1,7 +1,7 @@
getdns API {#mainpage} getdns API {#mainpage}
========== ==========
* Date: 2013-06-27 * Date: 2013-11-03
* GitHub: <https://github.com/verisign/getdns> * GitHub: <https://github.com/verisign/getdns>
getdns is a [modern asynchronous DNS API](http://www.vpnc.org/getdns-api/) intended to make all types of DNS information easily available as described by Paul Hoffman. This implementation is licensed under the New BSD License (BSD-new). getdns is a [modern asynchronous DNS API](http://www.vpnc.org/getdns-api/) intended to make all types of DNS information easily available as described by Paul Hoffman. This implementation is licensed under the New BSD License (BSD-new).
@ -27,16 +27,25 @@ The goals of this implementation of the getdns API are:
Non-goals (things we will not be doing) include: Non-goals (things we will not be doing) include:
* implementation of the traditional DNS related routines (gethostbyname, etc.) * implementation of the traditional DNS related routines (gethostbyname, etc.)
Contributors Releases
============ ========
* Neel Goyal, Verisign, Inc. Release numbering follows the [Semantic Versioning](http://semver.org/) approach. We are currently in the early stages of building the API so the code should be considered incomplete.
* Allison Mankin, Verisign, Inc.
* Melinda Shore, No Mountain Software LLC The 0.1.0 release will be issued when the repository is opened to the public, our goal is to meet the following requirements prior to opening the repository:
* Glen Wiley, Verisign, Inc.
* code compiles cleanly on at least the primary target platforms: RHEL/CentOS 6.3 Linux, FreeBSD 9.2
* examples must compile and be clean
* clearly document supported/unsupported elements of the API
Tickets/Bug Reports
===================
Tickets and bug reports from external contacts are received via a mailing list and managed in the git issues list.
TBD: mailing list address
External Dependencies External Dependencies
===================== =====================
External dependencies are linked outside the getdns API build tree (we rely on configure to find them). External dependencies are linked outside the getdns API build tree (we rely on configure to find them). We would like to keep the dependency tree short.
The project relies on [libldns from NL](https://www.nlnetlabs.nl/projects/ldns/) for parsing and constructing DNS packets. Version 1.6.16 (note that building ldns may require openssl headers and libraries) The project relies on [libldns from NL](https://www.nlnetlabs.nl/projects/ldns/) for parsing and constructing DNS packets. Version 1.6.16 (note that building ldns may require openssl headers and libraries)
@ -50,15 +59,38 @@ GNU autoconf is used to generate the configure script (and consequently the Make
Automake 1.12 is required if you are building the distribution tarball. Automake 1.12 is required if you are building the distribution tarball.
Current State of the Implementation
===================================
We are currently in the early stages of building the API so the code should be considered incomplete. The current target platforms and the personal primarily responsible for ensuring it builds and runs on that platform include:
* Android, Neel Goyal #Supported Platforms
* FreeBSD, Melinda Shore
* Linux RHEL/CentOS 6.x, Glen Wiley The primary platforms targeted are Linux and FreeBSD, other platform are supported as we get time. The names listed here are intended to help ensure that we catch platform specific breakage, not to limit the work that folks are doing.
* MS-Windows 8, Neel Goyal
* OSX 10.8, Glen Wiley Where at all possible we need to make sure that both 32 and 64 bit implementations work.
* Android, Neel
* FreeBSD 9.2, gcc/clang Melinda
* FreeBSD 10.0 (not yet released), gcc/clang Melinda
* Linux RHEL/CentOS 6.x, Glen
* MS-Windows 8, cygwin, Neel
* NetBSD x.x, Wouter
* OpenBSD 5.3, Wouter
* OSX 10.8, Glen
* OSX 10.9, Allison
* Ubuntu 12.x, Melinda
The NLNet folks offered to build on a number of legacy platforms as well to help ensure that the code is clean. These include some big endian hardware and a few more obscure operating systems which will not be publicly supported but might work if someone wants to try them.
##Build Reports
TBD
Contributors
============
* Neel Goyal, Verisign, Inc.
* Allison Mankin, Verisign, Inc.
* Melinda Shore, No Mountain Software LLC
* Willem Toorop, NLNet Labs
* Glen Wiley, Verisign, Inc.
* Wouter Wijngaards, NLNet Labs
-- --
end README end README

2
src/Doxyfile.in
View File

@ -52,7 +52,7 @@ PROJECT_LOGO =
# If a relative path is entered, it will be relative to the location # If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used. # where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = ./doc OUTPUT_DIRECTORY = ../doc
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output # 4096 sub-directories (in 2 levels) under the output directory of each output