From e868be1c3ef5a875a64b11af9613da5dffc71984 Mon Sep 17 00:00:00 2001
From: Martin Schroschk <martin.schroschk@tu-dresden.de>
Date: Tue, 24 Aug 2021 14:33:08 +0200
Subject: [PATCH] Review: rename file and fix command lines
---
.../docs/archive/ram_disk.md | 67 ++++++++++++++++++
.../docs/archive/ram_disk_documentation.md | 69 -------------------
doc.zih.tu-dresden.de/mkdocs.yml | 2 +-
3 files changed, 68 insertions(+), 70 deletions(-)
create mode 100644 doc.zih.tu-dresden.de/docs/archive/ram_disk.md
delete mode 100644 doc.zih.tu-dresden.de/docs/archive/ram_disk_documentation.md
diff --git a/doc.zih.tu-dresden.de/docs/archive/ram_disk.md b/doc.zih.tu-dresden.de/docs/archive/ram_disk.md
new file mode 100644
index 000000000..75e3c37c4
--- /dev/null
+++ b/doc.zih.tu-dresden.de/docs/archive/ram_disk.md
@@ -0,0 +1,67 @@
+# RAM Disk
+
+!!! warning
+
+ This page is outdated.
+
+On systems with a very large main memory, it is for some workloads very attractive to use parts of
+the main memory as a temporary file system. This will reduce file access times dramatically and has
+proven to speed up applications that are otherwise limited by I/O.
+
+We provide tools to allow users to create and destroy their own ramdisks. Currently, this is only
+allowed on the SGI UV2 (venus). Please note that the content of the ramdisk will vanish immediatelly
+when the ramdisk is destroyed or the machine crashes. Always copy out result data written to the
+ramdisk to another location.
+
+### Creating a RAM Disk
+
+On [Venus](hardware_venus.md), the creation of RAM disk is only allowed from within an LSF job. The
+memory used for the RAM disk will be deducted from the memory assigned to the LSF job. Thus, the
+amount of memory available for an LSF job determines the maximum size of the ramdisk. Per LSF job
+only a single ramdisk can be created (but you can create and delete a ramdisk multiple times during
+a job). You need to load the corresponding software module via
+
+```Bash
+module load ramdisk
+```
+
+Afterwards, the RAM disk can be created with the command
+
+```Bash
+make-ramdisk «size of the ramdisk in GB»
+```
+
+The path to the ramdisk is fixed to `/ramdisks/«JOBID»`.
+
+### Putting data onto the ramdisk
+
+The ramdisk itself works like a normal file system or directory. We
+provide a script that uses multiple threads to copy a directory tree. It
+can also be used to transfer single files but will only use one thread
+in this case. It is used as follows
+
+```Bash
+parallel-copy.sh «source directory or file» «target directory»
+```
+
+It is not specifically tailored to be used with the ramdisk. It can be
+used for any copy process between two locations.
+
+### Destruction of the ramdisk
+
+A ramdisk will automatically be deleted at the end of the job. As an
+alternative, you can delete your own ramdisk via the command
+
+```Bash
+kill-ramdisk
+```
+
+It is possible, that the deletion of the ramdisk fails. The reason for
+this is typically that some process still has a file open within the
+ramdisk or that there is still a program using the ramdisk or having the
+ramdisk as its current path. Locating these processes, that block the
+destruction of the ramdisk is possible via using the command
+
+```Bash
+lsof +d /ramdisks/«JOBID»
+```
diff --git a/doc.zih.tu-dresden.de/docs/archive/ram_disk_documentation.md b/doc.zih.tu-dresden.de/docs/archive/ram_disk_documentation.md
deleted file mode 100644
index 2f0a6071d..000000000
--- a/doc.zih.tu-dresden.de/docs/archive/ram_disk_documentation.md
+++ /dev/null
@@ -1,69 +0,0 @@
-# Ramdisk
-
-## Using parts of the main memory as a temporary file system
-
-On systems with a very large main memory, it is for some workloads very
-attractive to use parts of the main memory as a temporary file system.
-This will reduce file access times dramatically and has proven to speed
-up applications that are otherwise limited by I/O.
-
-We provide tools to allow users to create and destroy their own
-ramdisks. Currently, this is only allowed on the SGI UV2 (venus). Please
-note that the content of the ramdisk will vanish immediatelly when the
-ramdisk is destroyed or the machine crashes. Always copy out result data
-written to the ramdisk to another location.
-
-### Creating a ramdisk
-
-On venus, the creation of ramdisks is only allowed from within an LSF
-job. The memory used for the ramdisk will be deducted from the memory
-assigned to the LSF job. Thus, the amount of memory available for an LSF
-job determines the maximum size of the ramdisk. Per LSF job only a
-single ramdisk can be created (but you can create and delete a ramdisk
-multiple times during a job). You need to load the corresponding
-software module via
-
-```Bash
-module load ramdisk
-```
-
-Afterwards, the ramdisk can be created with the command
-
-```Bash
-make-ramdisk «size of the ramdisk in GB»
-```
-
-The path to the ramdisk is fixed to `/ramdisks/«JOBID»`.
-
-### Putting data onto the ramdisk
-
-The ramdisk itself works like a normal file system or directory. We
-provide a script that uses multiple threads to copy a directory tree. It
-can also be used to transfer single files but will only use one thread
-in this case. It is used as follows
-
-```Bash
-parallel-copy.sh «source directory or file» «target directory»
-```
-
-It is not specifically tailored to be used with the ramdisk. It can be
-used for any copy process between two locations.
-
-### Destruction of the ramdisk
-
-A ramdisk will automatically be deleted at the end of the job. As an
-alternative, you can delete your own ramdisk via the command
-
-```Bash
-kill-ramdisk
-```
-
-It is possible, that the deletion of the ramdisk fails. The reason for
-this is typically that some process still has a file open within the
-ramdisk or that there is still a program using the ramdisk or having the
-ramdisk as its current path. Locating these processes, that block the
-destruction of the ramdisk is possible via using the command
-
-```Bash
-lsof +d /ramdisks/«JOBID»
-```
diff --git a/doc.zih.tu-dresden.de/mkdocs.yml b/doc.zih.tu-dresden.de/mkdocs.yml
index 4699218ed..699b4a160 100644
--- a/doc.zih.tu-dresden.de/mkdocs.yml
+++ b/doc.zih.tu-dresden.de/mkdocs.yml
@@ -128,7 +128,7 @@ nav:
- No IB Jobs: archive/no_ib_jobs.md
- Phase2 Migration: archive/phase2_migration.md
- Platform LSF: archive/platform_lsf.md
- - RamDisk Documentation: archive/ram_disk_documentation.md
+ - RAM Disk: archive/ram_disk.md
- System Altix: archive/system_altix.md
- System Atlas: archive/system_atlas.md
- System Venus: archive/system_venus.md
--
GitLab