remove attributes.txt (use asciidoc/asciidoc-pve.conf instead)
authorDietmar Maurer <dietmar@proxmox.com>
Tue, 8 Nov 2016 05:46:43 +0000 (06:46 +0100)
committerDietmar Maurer <dietmar@proxmox.com>
Tue, 8 Nov 2016 05:46:43 +0000 (06:46 +0100)
54 files changed:
README.adoc
attributes.txt [deleted file]
datacenter.cfg.adoc
getting-help.adoc
ha-manager.adoc
howto-improve-pve-docs.adoc
index.adoc
local-lvm.adoc
local-zfs.adoc
pct.adoc
pct.conf.adoc
pmxcfs.adoc
pve-admin-guide.adoc
pve-bibliography.adoc
pve-disk-health-monitoring.adoc
pve-doc-generator.mk.in
pve-external-metric-server.adoc
pve-faq.adoc
pve-firewall.adoc
pve-ha-crm.adoc
pve-ha-lrm.adoc
pve-installation.adoc
pve-network.adoc
pve-package-repos.adoc
pve-storage-dir.adoc
pve-storage-glusterfs.adoc
pve-storage-iscsi.adoc
pve-storage-iscsidirect.adoc
pve-storage-lvm.adoc
pve-storage-lvmthin.adoc
pve-storage-nfs.adoc
pve-storage-rbd.adoc
pve-storage-zfspool.adoc
pve-system-requirements.adoc
pve-usbstick.adoc
pveam.adoc
pveceph.adoc
pvecm.adoc
pvedaemon.adoc
pveperf.adoc
pveproxy.adoc
pvesm.adoc
pvestatd.adoc
pvesubscription.adoc
pveum.adoc
qm.adoc
qm.conf.adoc
qmrestore.adoc
scan-adoc-refs
spiceproxy.adoc
sysadmin.adoc
system-software-updates.adoc
system-timesync.adoc
vzdump.adoc

index c82d82e..062b94e 100644 (file)
@@ -1,6 +1,5 @@
 Proxmox VE Documentation
 ========================
-include::attributes.txt[]
 
 We try to generate high quality documentation for
 {website}[{pve}], and choose to use
@@ -42,8 +41,8 @@ those Debian packages using:
  make deb
 
 
-Common Macro definition in link:attributes.txt[]
-------------------------------------------------
+Common Macro definition in link:asciidoc/asciidoc-pve.conf[]
+------------------------------------------------------------
 
 'asciidoc' allows us to define common macros, which can then be
 referred to using `{macro}`. We try to use this mechanism to improve
@@ -59,13 +58,12 @@ description
 For example, the macro `{forum-url}` expands to {forum-url}, and the macro
 `{forum}` expands to {forum}.
 
-The plan is to add more such definitions for terms which are used more than once.
+The plan is to add more such definitions for terms which are used more
+than once.
 
-WARNING: When asciidoc encounters a misspelled macro name, it will silently drop
-the containing line!
+WARNING: When asciidoc encounters a misspelled macro name, it will
+silently drop the containing line!
 
-WARNING: Never use macros in document titles or the ``NAME'' section of man pages,
-as these get parsed before the `attributes.txt` file gets included.
 
 Autogenerated CLI Command Synopsis
 ----------------------------------
diff --git a/attributes.txt b/attributes.txt
deleted file mode 100644 (file)
index 7ab1fa3..0000000
+++ /dev/null
@@ -1,14 +0,0 @@
-:proxmoxGmbh: Proxmox Server Solutions Gmbh
-:copyright:   {proxmoxGmbh}
-:pve:         Proxmox VE
-:website:     http://www.proxmox.com/
-:forum-url:   https://forum.proxmox.com/
-:forum:       https://forum.proxmox.com/[{pve} Community Forum]
-:webwiki-url:    https://pve.proxmox.com/wiki/
-:webwiki:        https://pve.proxmox.com/wiki/[{pve} Wiki]
-:manmanual:   {pve} Documentation
-:max-width:   55em
-ifndef::docinfo1[]
-:author:      {proxmoxGmbh}
-:email:       support@proxmox.com
-endif::docinfo1[]
index de64699..d940490 100644 (file)
@@ -2,7 +2,6 @@
 ifdef::manvolnum[]
 datacenter.cfg(5)
 =================
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -23,7 +22,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 Datacenter Configuration
 ========================
-include::attributes.txt[]
 endif::manvolnum[]
 ifdef::wiki[]
 :title: Manual: datacenter.cfg
index 97f80b4..fb2651f 100644 (file)
@@ -1,7 +1,6 @@
 [[getting_help]]
 Getting Help
 ------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 endif::wiki[]
index d49a8c6..79c9043 100644 (file)
@@ -2,7 +2,6 @@
 ifdef::manvolnum[]
 ha-manager(1)
 =============
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -21,7 +20,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 High Availability
 =================
-include::attributes.txt[]
 :pve-toplevel:
 endif::manvolnum[]
 
index 4e9bec2..a7a9abd 100644 (file)
@@ -1,7 +1,6 @@
 [[howto_improve_pve_docs]]
 Improving the Proxmox VE Documentation
 --------------------------------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 endif::wiki[]
index 9085132..7893104 100644 (file)
@@ -1,6 +1,5 @@
 image:./images/proxmox-logo.svg[] pass:[<br>] {pve} Documentation Index
 ========================================================================
-include::attributes.txt[]
 :data-uri:
 :icons:
 :title: {pve} Documentation Index
index 45e875f..c5872be 100644 (file)
@@ -1,6 +1,5 @@
 Logical Volume Manager (LVM)
 ----------------------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 endif::wiki[]
index 6aae81e..e9d0857 100644 (file)
@@ -1,6 +1,5 @@
 ZFS on Linux
 ------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 endif::wiki[]
index 5f2fb3f..fde647a 100644 (file)
--- a/pct.adoc
+++ b/pct.adoc
@@ -2,7 +2,6 @@
 ifdef::manvolnum[]
 pct(1)
 ======
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -23,7 +22,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 Proxmox Container Toolkit
 =========================
-include::attributes.txt[]
 :pve-toplevel:
 endif::manvolnum[]
 ifdef::wiki[]
index 7fba83d..d967d79 100644 (file)
@@ -1,7 +1,6 @@
 ifdef::manvolnum[]
 pct.conf(5)
 ===========
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -23,7 +22,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 Container Configuration
 =======================
-include::attributes.txt[]
 endif::manvolnum[]
 ifdef::wiki[]
 :pve-toplevel:
index 764cdf4..12e51d1 100644 (file)
@@ -1,7 +1,6 @@
 ifdef::manvolnum[]
 pmxcfs(8)
 =========
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -21,7 +20,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 Proxmox Cluster File System (pmxcfs)
 ====================================
-include::attributes.txt[]
 :pve-toplevel:
 endif::manvolnum[]
 
index e1d1d77..289fe8a 100644 (file)
@@ -6,7 +6,6 @@ ifndef::pvelogo[]
 Proxmox VE Administration Guide
 ===============================
 endif::pvelogo[]
-include::attributes.txt[]
 :doctype:   book
 :title: Proxmox VE Administration Guide
 :toc:
index e1fc280..ed78fcc 100644 (file)
@@ -1,7 +1,6 @@
 [bibliography]
 Bibliography
 ============
-include::attributes.txt[]
 ifndef::manvolnum[]
 :pve-toplevel:
 endif::manvolnum[]
index e5f0934..99ba8aa 100644 (file)
@@ -1,6 +1,5 @@
 Disk Health Monitoring
 ----------------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 endif::wiki[]
index 65600a1..8c2e2a5 100644 (file)
@@ -7,7 +7,6 @@ ASCIIDOC_PVE?=/usr/bin/asciidoc-pve
 
 PVE_COMMON_DOC_SOURCES=                 \
        ${ASCIIDOC_PVE}                 \
-       attributes.txt                  \
        pve-copyright.adoc              \
        docinfo.xml
 
@@ -76,4 +75,4 @@ chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES}
 
 .PHONY: cleanup-docgen
 cleanup-docgen:
-       rm -f *.xml.tmp *.1 *.5 *.8 *.adoc attributes.txt docinfo.xml
+       rm -f *.xml.tmp *.1 *.5 *.8 *.adoc docinfo.xml
index 6adc95d..0a7c36e 100644 (file)
@@ -1,6 +1,5 @@
 External Metric Server
 ----------------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 endif::wiki[]
index abaadcd..ebdb1d4 100644 (file)
@@ -1,6 +1,5 @@
 Frequently Asked Questions
 ==========================
-include::attributes.txt[]
 ifndef::manvolnum[]
 :pve-toplevel:
 endif::manvolnum[]
index 8f5936c..1c94636 100644 (file)
@@ -2,7 +2,6 @@
 ifdef::manvolnum[]
 pve-firewall(8)
 ===============
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -23,7 +22,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 {pve} Firewall
 ==============
-include::attributes.txt[]
 :pve-toplevel:
 endif::manvolnum[]
 ifdef::wiki[]
index 6386bfd..35f9e00 100644 (file)
@@ -1,7 +1,6 @@
 ifdef::manvolnum[]
 pve-ha-crm(8)
 =============
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 Cluster Resource Manager Daemon
 ================================
-include::attributes.txt[]
 endif::manvolnum[]
 
 This is the Cluster Resource Manager Daemon.
index 1099160..c5c7625 100644 (file)
@@ -1,7 +1,6 @@
 ifdef::manvolnum[]
 pve-ha-lrm(8)
 =============
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 Local Resource Manager Daemon
 ==============================
-include::attributes.txt[]
 endif::manvolnum[]
 
 This is the Local Resource Manager Daemon.
index f25ac2d..8726ef9 100644 (file)
@@ -1,6 +1,5 @@
 Installing Proxmox VE
 =====================
-include::attributes.txt[]
 ifndef::manvolnum[]
 :pve-toplevel:
 endif::manvolnum[]
index e6deb43..fd52357 100644 (file)
@@ -1,7 +1,6 @@
 [[sysadmin_network_configuration]]
 Network Configuration
 ---------------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 endif::wiki[]
index 334f2b9..e23c01e 100644 (file)
@@ -1,7 +1,6 @@
 [[sysadmin_package_repositories]]
 Package Repositories
 --------------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 endif::wiki[]
index a5084f8..71d87a1 100644 (file)
@@ -1,6 +1,5 @@
 Directory Backend
 -----------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 :title: Storage: Directory
index 3752402..f12884a 100644 (file)
@@ -1,6 +1,5 @@
 GlusterFS Backend
 -----------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 :title: Storage: GlusterFS
index 8d29d61..7d1511c 100644 (file)
@@ -1,6 +1,5 @@
 http://www.open-iscsi.org/[Open-iSCSI] initiator
 ------------------------------------------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 :title: Storage: iSCSI
index f3287f7..bace901 100644 (file)
@@ -1,6 +1,5 @@
 User Mode iSCSI Backend
 -----------------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 :title: Storage: User Mode iSCSI
index bbfa08b..b337c86 100644 (file)
@@ -1,6 +1,5 @@
 LVM Backend
 -----------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 :title: Storage: LVM
index a29175e..1a9d55b 100644 (file)
@@ -1,6 +1,5 @@
 LVM thin Backend
 ----------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 :title: Storage: LVM Thin
index ec4699a..24644de 100644 (file)
@@ -1,6 +1,5 @@
 NFS Backend
 -----------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 :title: Storage: NFS
index cafc5da..c33b70e 100644 (file)
@@ -1,6 +1,5 @@
 Ceph RADOS Block Devices (RBD)
 ------------------------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 :title: Storage: RBD
index 7974984..ca1b771 100644 (file)
@@ -1,6 +1,5 @@
 Local ZFS Pool Backend
 ----------------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 :title: Storage: ZFS
index a5bbffa..52aa608 100644 (file)
@@ -1,6 +1,5 @@
 System Requirements
 -------------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 endif::wiki[]
index fb30a4c..5f01aae 100644 (file)
@@ -1,6 +1,5 @@
 Install from USB Stick
 ----------------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 endif::wiki[]
index 97d9d5b..43da99c 100644 (file)
@@ -1,7 +1,6 @@
 ifdef::manvolnum[]
 pveam(1)
 ========
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 Container Images
 ================
-include::attributes.txt[]
 endif::manvolnum[]
 
 Command line tool to manage container images. See `man pct` for usage
index bc190d9..915017e 100644 (file)
@@ -2,7 +2,6 @@
 ifdef::manvolnum[]
 pveceph(1)
 ==========
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -21,7 +20,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 pveceph - Manage CEPH Services on Proxmox VE Nodes
 ==================================================
-include::attributes.txt[]
 endif::manvolnum[]
 
 Tool to manage http://ceph.com[CEPH] services on {pve} nodes.
index bb1477b..8db8e47 100644 (file)
@@ -1,7 +1,6 @@
 ifdef::manvolnum[]
 pvecm(1)
 ========
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -21,7 +20,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 Cluster Manager
 ===============
-include::attributes.txt[]
 :pve-toplevel:
 endif::manvolnum[]
 
index fc554a5..66c751a 100644 (file)
@@ -1,7 +1,6 @@
 ifdef::manvolnum[]
 pvedaemon(8)
 ============
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 pvedaemon - Proxmox VE API Daemon
 =================================
-include::attributes.txt[]
 endif::manvolnum[]
 
 This daemon exposes the whole {pve} API on `127.0.0.1:85`. It runs as
index 4a01f90..bb11509 100644 (file)
@@ -1,7 +1,6 @@
 ifdef::manvolnum[]
 pveperf(1)
 ==========
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 pveperf - Proxmox VE Benchmark Script
 =====================================
-include::attributes.txt[]
 endif::manvolnum[]
 
 Tries to gather some CPU/hard disk performance data on the hard disk
index 5ea15fe..5b83106 100644 (file)
@@ -1,7 +1,6 @@
 ifdef::manvolnum[]
 pveproxy(8)
 ===========
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 pveproxy - Proxmox VE API Proxy Daemon
 ======================================
-include::attributes.txt[]
 endif::manvolnum[]
 
 This daemon exposes the whole {pve} API on TCP port 8006 using
index d41ab41..9739087 100644 (file)
@@ -2,7 +2,6 @@
 ifdef::manvolnum[]
 pvesm(1)
 ========
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 {pve} Storage
 =============
-include::attributes.txt[]
 :pve-toplevel:
 endif::manvolnum[]
 ifdef::wiki[]
index eb96874..5a51ad7 100644 (file)
@@ -1,7 +1,6 @@
 ifdef::manvolnum[]
 pvestatd(8)
 ===========
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -21,7 +20,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 pvestatd - Proxmox VE Status Daemon
 ===================================
-include::attributes.txt[]
 endif::manvolnum[]
 
 This daemon queries the status of VMs, storages and containers at
index 910cdb7..75af064 100644 (file)
@@ -1,7 +1,6 @@
 ifdef::manvolnum[]
 pvesubscription(1)
 ==================
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -21,7 +20,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 pvesubscription - Subscription Management
 =========================================
-include::attributes.txt[]
 endif::manvolnum[]
 
 This tool is used to handle {pve} subscriptions.
index 14fff25..db196b5 100644 (file)
@@ -2,7 +2,6 @@
 ifdef::manvolnum[]
 pveum(1)
 ========
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -23,7 +22,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 User Management
 ===============
-include::attributes.txt[]
 :pve-toplevel:
 endif::manvolnum[]
 
diff --git a/qm.adoc b/qm.adoc
index eeb4ae6..47813f7 100644 (file)
--- a/qm.adoc
+++ b/qm.adoc
@@ -2,7 +2,6 @@
 ifdef::manvolnum[]
 qm(1)
 =====
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 Qemu/KVM Virtual Machines
 =========================
-include::attributes.txt[]
 :pve-toplevel:
 endif::manvolnum[]
 
index 70392e6..ddfd65d 100644 (file)
@@ -1,7 +1,6 @@
 ifdef::manvolnum[]
 qm.conf(5)
 ==========
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -23,7 +22,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 Virtual Machine Configuration
 =============================
-include::attributes.txt[]
 endif::manvolnum[]
 ifdef::wiki[]
 :pve-toplevel:
index 2898372..37f185a 100644 (file)
@@ -1,7 +1,6 @@
 ifdef::manvolnum[]
 qmrestore(1)
 ============
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -21,7 +20,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 Restore Virtual Machines
 ========================
-include::attributes.txt[]
 endif::manvolnum[]
 
 
index 732bc34..9252701 100755 (executable)
@@ -467,6 +467,7 @@ if ($generate_depends) {
        my $filelist = $fileinfo->{outfile}->{$e};
        foreach my $sourcefile (sort keys %$filelist) {
            my $varname = $depend_varname_hash->{$sourcefile};
+           next if !defined($varname);
            my $target = $filelist->{$sourcefile};
            my $dep = "\$\{$varname\}";
            $make_targets->{$target} = $dep;
index d030090..4ebee69 100644 (file)
@@ -1,7 +1,6 @@
 ifdef::manvolnum[]
 spiceproxy(8)
 =============
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 spiceproxy - SPICE Proxy Service
 ================================
-include::attributes.txt[]
 endif::manvolnum[]
 
 http://www.spice-space.org[SPICE] (the Simple Protocol for Independent
index 9f5582d..421ab94 100644 (file)
@@ -1,7 +1,6 @@
 [[chapter_system_administration]]
 Host System Administration
 ==========================
-include::attributes.txt[]
 ifndef::manvolnum[]
 :pve-toplevel:
 endif::manvolnum[]
index dce7979..04c17f3 100644 (file)
@@ -1,6 +1,5 @@
 System Software Updates
 -----------------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 endif::wiki[]
index 86e16d3..e307883 100644 (file)
@@ -1,6 +1,5 @@
 Time Synchronization
 --------------------
-include::attributes.txt[]
 ifdef::wiki[]
 :pve-toplevel:
 endif::wiki[]
index 12055b4..5c6804c 100644 (file)
@@ -2,7 +2,6 @@
 ifdef::manvolnum[]
 vzdump(1)
 =========
-include::attributes.txt[]
 :pve-toplevel:
 
 NAME
@@ -23,7 +22,6 @@ endif::manvolnum[]
 ifndef::manvolnum[]
 Backup and Restore
 ==================
-include::attributes.txt[]
 :pve-toplevel:
 endif::manvolnum[]