]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
doc: Convert doc/directories.adoc from markdown to asciidoc (#2878)
authorJorge Pereira <jpereira@users.noreply.github.com>
Tue, 13 Aug 2019 17:51:52 +0000 (14:51 -0300)
committerArran Cudbard-Bell <a.cudbardb@freeradius.org>
Tue, 13 Aug 2019 17:51:52 +0000 (13:51 -0400)
* doc: Rename doc/directories.{md,adoc}

* doc: Convert doc/directories.adoc from markdown to asciidoc

doc/directories.adoc [new file with mode: 0644]
doc/directories.md [deleted file]

diff --git a/doc/directories.adoc b/doc/directories.adoc
new file mode 100644 (file)
index 0000000..00cfa3d
--- /dev/null
@@ -0,0 +1,66 @@
+= Directories
+
+The directories in the server source are laid out ad follows:
+
+== Documentation
+
+[width="100%",cols="50%,50%",options="header",]
+|===
+| Directory           | Description
+| `doc/`              | Various snippets of documentation.
+| `doc/introduction/` | Concepts and introduction to FreeRADIUS.
+| `doc/raddb/`        | HTML versions of the configuration files.
+| `doc/source/`       | Developer documentation for internal APIs
+| `doc/unlang/`       | The unlang processing language.
+| `doc/upgrade/`      | How to upgrade from version 3 to version 4.
+| `doc/rfc/`          | Copies of the RFC’s. If you have Perl, do a `make` in
+                        that directory, and look at the HTML output.
+| `man/`              | Unix Manual pages for the server, configuration files,
+                        and associated utilities.
+|===
+
+== Utility
+
+[cols=",",options="header",]
+|===
+|Directory   | Description
+| `mibs/`    | SNMP Mibs for the server.
+| `scripts/` | Sample scripts for startup and maintenance.
+|===
+
+== Configuration
+
+[width="100%",cols="50%,50%",options="header",]
+|===
+| Directory               | Description
+| `raddb/`                | Sample configuration files for the server.
+| `raddb/mods-available`  | Module configuration files.
+| `raddb/mods-enabled`    | Directory containing symlinks to `raddb/mods-available`.
+                            Controls which modules are enabled.
+| `raddb/sites-available` | Virtual servers.
+| `raddb/sites-enabled`   | Directory containing symlinks to `raddb/sites-available`. 
+                            Control which virtual servers are enabled.
+|===
+
+== Packaging
+
+[cols=",",options="header",]
+|===
+|Directory  | Description
+| `debian/` | Files to build a `freeradius` Debian Linux package.
+| `redhat/` | Additional files for a RedHat Linux system.
+| `suse/`   | Additional files for a SuSE (UnitedLinux) system.
+|===
+
+== Source
+
+[cols=",",options="header",]
+|===
+|Directory         | Description
+| `src/`           | Source code.
+| `src/bin/`       | Source code for the daemon and associated utilities.
+| `src/lib/`       | Source code for various utility libraries.
+| `src/include/`   | Header files.
+| `src/protocols/` | Dynamic frontend plug-in modules.
+| `src/modules/`   | Dynamic backend plug-in modules.
+|===
diff --git a/doc/directories.md b/doc/directories.md
deleted file mode 100644 (file)
index ad3b9a2..0000000
+++ /dev/null
@@ -1,50 +0,0 @@
-# Directories
-
-The directories in the server source are laid out ad follows:
-
-### Documentation
-
-| Directory                    | Description
-|---                           |---
-| `doc/`                       | Various snippets of documentation
-| `doc/introduction/`          | Concepts and introduction to FreeRADIUS
-| `doc/raddb/`                 | HTML versions of the configuration files
-| `doc/source/`                        | Developer documentation for internal APIs
-| `doc/unlang/`                        | The unlang processing language
-| `doc/upgrade/`               | How to upgrade from version 3 to version 4.
-| `doc/rfc/`                   | Copies of the RFC's.  If you have Perl, do a 'make' in that directory, and look at the HTML output.
-| `man/`                       | Unix Manual pages for the server, configuration files, and associated utilities.
-
-### Utility
-
-| Directory                    | Description
-|---                           |---
-| `mibs/`                      | SNMP Mibs for the server.
-| `scripts/`                   | Sample scripts for startup and maintenance.
-
-### Configuration
-
-| Directory                    | Description
-|---                           |---
-| `raddb/`                     | Sample configuration files for the server.
-| `raddb/mods-available`       | Module configuration files.
-| `raddb/mods-enabled`         | Directory containing symlinks to raddb/mods-available. Controls which modules are enabled.
-| `raddb/sites-available`      | Virtual servers.
-| `raddb/sites-enabled`                | Directory containing symlinks to raddb/sites-available. Control which virtual servers are enabled.
-
-### Packaging
-| Directory                    | Description
-|---                           |---
-| `debian/`                    | Files to build a "freeradius" Debian Linux package.
-| `redhat/`                    | Additional files for a RedHat Linux system.
-| `suse/`                      | Additional files for a SuSE (UnitedLinux) system.
-
-### Source
-| Directory                    | Description
-|---                           |---
-| `src/`                       | Source code
-| `src/bin/`                   | Source code for the daemon and associated utilities.
-| `src/lib/`                   | Source code for various utility libraries.
-| `src/include/`               | Header files.
-| `src/protocols/`             | Dynamic frontend plug-in modules.
-| `src/modules/`               | Dynamic backend plug-in modules.