]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
documentation updates
authorMatthew Newton <matthew-git@newtoncomputing.co.uk>
Mon, 19 Mar 2018 11:54:38 +0000 (11:54 +0000)
committerMatthew Newton <matthew-git@newtoncomputing.co.uk>
Thu, 29 Mar 2018 21:56:41 +0000 (22:56 +0100)
CONTRIBUTING
COPYRIGHT
CREDITS
README.rst
raddb/mods-available/linelog

index 7deb291174f2166c862d477796cb6b211e704217..b0895036108cf93df9a2a6469d36a7aaa5a837c2 100644 (file)
@@ -20,7 +20,7 @@
   It is not for support requests or questions regarding configuration/operation of the server, they
   belong on the users mailing list:
 
-    http://freeradius.org/list/users.html
+    https://freeradius.org/support/
 
   Raising support requests or questions as issues will result in them being closed and locked.  If you
   continue to raise these questions as issues you will be banned from the FreeRADIUS project's GitHub
@@ -47,7 +47,7 @@
 
 3.CONTENTS OF A DEFECT REPORT
 
-  See doc/bugs (https://github.com/FreeRADIUS/freeradius-server/blob/master/doc/bugs) for information
+  See doc/bugs (https://github.com/FreeRADIUS/freeradius-server/blob/v3.0.x/doc/bugs) for information
   on what to include, and how to obtain it.
 
   When logging bug reports using the GitHub issue tracker, pay attention to formatting.  You should
   a member of the FreeRADIUS development team first.  For simpler one or two line fixes, go ahead and
   open a pull-request immediately.
 
-  The dev team can be contacted via the devel mailing list (http://freeradius.org/list/devel.html),
+  The dev team can be contacted via the devel mailing list (https://freeradius.org/support/),
   or via GitHub by using the GitHub issue tracker.
 
   Contacting the dev team gives us the opportunity to offer feedback.  We may have a solution to your
   problem that doesn't require additional code, or may have ideas as to how your problem can be solved
-  in a way that will better fit with the longterm vision for the server.
+  in a way that will better fit with the long-term vision for the server.
 
   Once you've got the go ahead, read through the coding standards document:
 
-    http://wiki.freeradius.org/contributing/coding-standards
+    https://wiki.freeradius.org/contributing/coding-standards
 
   If you're creating a new module you may wish to read the module creation guide:
 
-    http://wiki.freeradius.org/contributing/Modules3
+    https://wiki.freeradius.org/contributing/Modules3
 
   You may also wish to utilise the doxygen site to review code documentation:
 
@@ -89,7 +89,7 @@
   Git/GitHub knowledge is assumed.  If you're wondering what the heck a pull-request is, this
   document may be of some use:
 
-    http://wiki.freeradius.org/contributing/GitHub
+    https://wiki.freeradius.org/contributing/GitHub
 
 
 5.CONTINUOUS INTEGRATION TESTS
index 239820c1025445a2653cfa0125422d5b35529eb3..2062476a64a73d5dacbdfade933ab47a4e65f332 100644 (file)
--- a/COPYRIGHT
+++ b/COPYRIGHT
@@ -42,7 +42,7 @@ individuals.  This list is not exhaustive.  Consult the individual
 files for more detailed copyright statements.
 
 
-Copyright (C) 1999-2015 The FreeRADIUS Server Project
+Copyright (C) 1999-2018 The FreeRADIUS Server Project
 
 Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Alan DeKok
 <aland@deployingradius.com>
@@ -52,6 +52,8 @@ Software Foundation, Inc.
 
 Copyright (C) 2011-2015 Arran Cudbard-Bell <a.cudbardb@freeradius.org>
 
+Copyright (C) 2012-2018 Matthew Newton <matthew-git@newtoncomputing.co.uk>
+
 Copyright (C) 2003, 2004, 2005 Kostas Kalevras <kkalev@noc.ntua.gr>
 
 Copyright (C) 2004  Cladju Consulting, Inc.
diff --git a/CREDITS b/CREDITS
index 6cfae4f4a83f5953856f933110d75e77dd73f794..2dcb96b4cd7d45966cddb09a9806fcc656def345 100644 (file)
--- a/CREDITS
+++ b/CREDITS
@@ -1,2 +1,2 @@
 Please see:
- http://wiki.freeradius.org/project/Acknowledgements
+ https://wiki.freeradius.org/project/Acknowledgements
index 45005faf856682d2f1d6f7b5743685de2c49ed14..d7d96a4e0b334f54b78b9529ba97a5ae91cf9275 100644 (file)
@@ -38,7 +38,7 @@ existing configuration should be carefully migrated to the new
 version, in order to take advantage of the new features which can
 greatly simply configuration.
 
-Please see http://freeradius.org and http://wiki.freeradius.org for
+Please see https://freeradius.org and https://wiki.freeradius.org for
 more information.
 
 
@@ -89,20 +89,18 @@ problems can be solved by carefully reading the debugging output,
 which includes WARNINGs about common issues, and suggestions for how
 they may be fixed.
 
-Read the FAQ.  Many questions are answered there.  See the Wiki
+Many questions are answered on the Wiki:
 
-http://wiki.freeradius.org
+https://wiki.freeradius.org
 
-Read the configuration files.  Many parts of the server have NO
-documentation, other than comments in the configuration file.
+Read the configuration files.  Many parts of the server are
+documented only with extensive comments in the configuration files.
 
-Search the mailing lists.  There is a Google link on the bottom of
-the page:
+Search the mailing lists. For example, using Google, searching
+"site:lists.freeradius.org <search term>" will return results from
+the FreeRADIUS mailing lists.
 
-http://www.freeradius.org/list/users.html
-
-Type some key words into the search box, and you should find
-discussions about common problems and solution.
+https://freeradius.org/support/
 
 
 Feedback, Defects, and Community Support
@@ -110,7 +108,7 @@ Feedback, Defects, and Community Support
 
 If you have any comments, or are having difficulty getting FreeRADIUS
 to do what you want, please post to the 'freeradius-users' list
-(see the URL above).  The FreeRADIUS mailing list is operated and
+(see the URL above).  The FreeRADIUS mailing list is operated, and
 contributed to, by the FreeRADIUS community. Users of the list will be
 more than happy to answer your questions, with the caveat that you've
 read documentation relevant to your issue first.
@@ -118,11 +116,14 @@ read documentation relevant to your issue first.
 If you suspect a defect in the server, would like to request a feature,
 or submit a code patch, please use the GitHub issue tracker for the
 freeradius-server `repository
-<https://github.com/FreeRADIUS/freeradius-server>`_.
+<https://github.com/FreeRADIUS/freeradius-server>`_. However, it
+is nearly always best to raise the issue on the mailing lists
+first to determine whether it really is a defect or missing
+feature..
 
 Instructions for gathering data for defect reports can be found in
 ``doc/bugs`` or on the `wiki
-<http://wiki.freeradius.org/project/bug-reports>`_.
+<https://wiki.freeradius.org/project/bug-reports>`_.
 
 Under no circumstances should the issue tracker be used for support
 requests, those questions belong on the user's mailing list.  If you
@@ -158,18 +159,17 @@ Books on RADIUS
 See ``doc/README`` for more information about FreeRADIUS.
 
 There is an O'Reilly book available.  It serves as a good
-introduction for anyone new to RADIUS.  However, it is almost 12 years
+introduction for anyone new to RADIUS.  However, it is almost 18 years
 old, and is not much more than a basic introduction to the subject.
 
-http://www.amazon.com/exec/obidos/ASIN/0596003226/freeradiusorg-20/
+https://www.amazon.com/exec/obidos/ASIN/0596003226/freeradiusorg-20/
 
 Commercial support
 ------------------
 
 Technical support, managed systems support, custom deployments,
 sponsored feature development and many other commercial services
-are available from `Network RADIUS
-<http://www.networkradius.com>`_.
+are available from `Network RADIUS <http://www.networkradius.com>`_.
 
 
 .. |CoverityStatus| image:: https://scan.coverity.com/projects/58/badge.svg?
index c646da0a05cbdf6e984f79cea105de41de4b0528..dc2a8195b3c1c2251fc37651ea4a598898c33d12 100644 (file)
@@ -104,7 +104,7 @@ linelog {
 
        #
        #  Reference the Packet-Type (Access-Accept, etc.)  If it doesn't
-       #  exist, reference the "defaukt" entry.
+       #  exist, reference the "default" entry.
        #
        #  This is for "linelog" being used in the post-auth section
        #  If you want to use it in "authorize", you need to change