start file format docu

diff --git a/docs/conf.py b/docs/conf.py
index c80268db7dbea49795908bc424eddef75822b6df..11f1f00da6b92acbb966298ea770226761af5b9d 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -30,7 +30,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = ["sphinx.ext.graphviz"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/docs/file-formats.rst b/docs/file-formats.rst
new file mode 100644 (file)
index 0000000..afa257e
--- /dev/null
+++ b/docs/file-formats.rst
@@ -0,0 +1,10 @@
+File Formats
+============
+
+Proxmox File Archive Format (``.pxar``)
+---------------------------------------
+
+
+.. graphviz:: pxar-format-overview.dot
+
+             

diff --git a/docs/index.rst b/docs/index.rst
index 50958cc938208a73984a69d408b5b78a2a6ea201..9eedf88e59172f07935b298eb0f66362bf55c1e4 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -24,6 +24,7 @@ Welcome to Proxmox Backup's documentation!
    :caption: Appendix
 
    command-syntax.rst
+   file-formats.rst
    glossary.rst
 
 * :ref:`genindex`

diff --git a/docs/pxar-format-overview.dot b/docs/pxar-format-overview.dot
new file mode 100644 (file)
index 0000000..8d4ab21
--- /dev/null
+++ b/docs/pxar-format-overview.dot
@@ -0,0 +1,43 @@
+digraph g {
+graph [
+rankdir = "LR"
+fontname="Helvetica"
+];
+node [
+fontsize = "16"
+shape = "record"
+];
+edge [
+];
+
+"archive" [
+label = "archive.pxar"
+shape = "record"
+];
+
+"rootdir" [
+label = "<f0> ENTRY| \{XATTR\}\* extended attribute list\l | \{ACL_USER\}\* USER ACL entries\l | \{ACL_GROUP\}\* GROUP ACL entries\l| \[ACL_GROUP_OBJ\] the ACL_GROUP_OBJ \l| \[ACL_DEFAULT\] the various default ACL fields\l|\{ACL_DEFAULT_USER\}\* USER ACL entries\l|\{ACL_DEFAULT_GROUP\}\* GROUP ACL entries\l|\[FCAPS\] file capability in Linux disk format\l|\[QUOTA_PROJECT_ID\] the ext4/xfs quota project ID\l| { PAYLOAD  | SYMLINK | DEVICE | { <de> \{DirectoryEntries\}\* | GOODBYE}}"
+shape = "record"
+];
+
+
+"entry" [
+label = "<f0> size: u64 = 64\l|type: u64 = ENTRY\l|feature_flags: u64\l|mode: u64\l|flags: u64\l|uid: u64\l|gid: u64\l|mtime: u64\l"
+labeljust = "l"
+shape = "record"
+];
+
+
+
+"direntry" [
+label = "<f0> FILENAME |{ENTRY | HARDLINK}"
+shape = "record"
+];
+
+"archive" -> "rootdir":f0
+
+"rootdir":f0 -> "entry":f0
+
+"rootdir":de -> "direntry":f0
+
+}
\ No newline at end of file