[pve-devel] [PATCH] pmxcfs: fix wrong information now covered in pvecm

Fabian Grünbichler f.gruenbichler at proxmox.com
Thu Oct 20 12:23:24 CEST 2016


On Thu, Oct 20, 2016 at 12:01:48PM +0200, Thomas Lamprecht wrote:
> Linking stuff is currently not trivial, multiple ifdef have to be defined.
> Further asciidoc cannot do "elsif" or "else" which makes the process
> cumbersome.
> Also inter linking to other chapters is not really possible, afaik. At least
> not if I open a chapter-%.html, int the all in one pve-admin-guide.html it
> works naturally.
> 
> A preprocessor directive like link::/pve-docs-link/CHAPTER/ID
> for example: link::/pve-docs-link/pvecm/heading-id
> which generates context sensitive:
> * link to the id for the all in one docs (pve-admin-guide.*)
> * link to the other chapter + id for the single chapter one
> * the wiki link for wiki pages
> * a note for man pages to look at "man CHAPTER Section ID"
> 
> would be an idea, cannot really say how good it works with the current
> preprocessor/tooling. (hadn't time to test implement it).
> Any comments here?

as far as I understood, simply defining an anchor with [[some-id]] and
linking to it with <<some-id,text for link>> should work.

for the complete html, this is already resolved by asciidoc.
for the rest, our preprocessor takes care of extracting the anchors and
figuring out how to link to them for the various formats (across
file/page/.. boundaries).

the following on top of your patch seems to work (wiki not tested ;)):

diff --git a/pmxcfs.adoc b/pmxcfs.adoc
index a02d82e..da7b089 100644
--- a/pmxcfs.adoc
+++ b/pmxcfs.adoc
@@ -175,22 +175,7 @@ your cluster. This makes sure that all secret cluster/ssh keys and any
 shared configuration data is destroyed.
 
 In some cases, you might prefer to put a node back to local mode without
-reinstall, which is described in the 'Separate A Node Without Reinstalling'
-paragraph from the 'Cluster Manager' category.
-
-ifdef::manvolnum[]
-See:
-[source,bash]
-----
-man pvecm
-----
-endif::manvolnum[]
-
-ifdef::wiki[]
-See:
-
-link:/wiki/Cluster_Manager[Cluster Manager]
-endif::wiki[]
+reinstall, which is described in the <<pvecm_separate_without_reinstalling,pvecm documentation>>.
 
 ifdef::manvolnum[]
 include::pve-copyright.adoc[]
diff --git a/pvecm.adoc b/pvecm.adoc
index 8b3290f..6f66c38 100644
--- a/pvecm.adoc
+++ b/pvecm.adoc
@@ -295,6 +295,7 @@ cluster again, you have to
 
 * then join it, as explained in the previous section.
 
+[[pvecm_separate_without_reinstalling]]
 Separate A Node Without Reinstalling
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 





More information about the pve-devel mailing list