Merge branch 'develop'

Reviewed-on: #36

README.md

@@ -22,9 +22,9 @@ Instructions how to create a standalone machine that boots directly to reHDD. Th
 * Upload reHDD log every 12h if wanted
 
 ### Software requirements
-
 * `apt-get install hwinfo smartmontools curl`
 
+
 ### Installation
 
 clone this repo into /root/
@@ -43,3 +43,7 @@ Get the first 8 Bytes from your UUID via `blkid /dev/sdX`
 
 `reboot`
 
+## Build docs 
+`make docs`
+
+open `doc/html/index.html` in browser

doc/doxyfile

@@ -467,7 +467,7 @@ LOOKUP_CACHE_SIZE      = 0
 # normally produced when WARNINGS is set to YES.
 # The default value is: NO.
 
-EXTRACT_ALL            = NO
+EXTRACT_ALL            = YES
 
 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
 # be included in the documentation.
@@ -904,7 +904,7 @@ FILE_PATTERNS          = *.c \
 # be searched for input files as well.
 # The default value is: NO.
 
-RECURSIVE              = NO
+RECURSIVE              = YES
 
 # The EXCLUDE tag can be used to specify files and/or directories that should be
 # excluded from the INPUT source files. This way you can easily exclude a
@@ -1493,7 +1493,7 @@ ECLIPSE_DOC_ID         = org.doxygen.Project
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-DISABLE_INDEX          = NO
+DISABLE_INDEX          = YES
 
 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
 # structure should be generated to display hierarchical information. If the tag
@@ -1510,7 +1510,7 @@ DISABLE_INDEX          = NO
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-GENERATE_TREEVIEW      = NO
+GENERATE_TREEVIEW      = YES
 
 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
 # doxygen will group on one line in the generated HTML documentation.
@@ -2260,7 +2260,7 @@ HIDE_UNDOC_RELATIONS   = YES
 # set to NO
 # The default value is: NO.
 
-HAVE_DOT               = NO
+HAVE_DOT               = YES
 
 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
 # to run in parallel. When set to 0 doxygen will base this on the number of
@@ -2326,7 +2326,7 @@ GROUP_GRAPHS           = YES
 # The default value is: NO.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-UML_LOOK               = NO
+UML_LOOK               = YES
 
 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
 # class node. If there are many fields or methods and many nodes the graph may
@@ -2377,7 +2377,7 @@ INCLUDED_BY_GRAPH      = YES
 # The default value is: NO.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-CALL_GRAPH             = NO
+CALL_GRAPH             = YES
 
 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
 # dependency graph for every global function or class method.
@@ -2389,7 +2389,7 @@ CALL_GRAPH             = NO
 # The default value is: NO.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-CALLER_GRAPH           = NO
+CALLER_GRAPH           = YES
 
 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
 # hierarchy of all classes instead of a textual one.

doc/prototype_manual_DE.md

@@ -1,60 +0,0 @@
-# Installation
-**[1]** In terminal als root einloggen\
-**[2]** In reHDD_prototype wechseln\
-**[3]** Abhängigkeiten installieren\
-`apt-get install smartmontools`\
-`apt-get install hwinfo`\
-`apt-get install util-linux`
-
-**[4]** reHDD ausführbar machen\
-`chmod +x reHDD`\
-**[5]** ignoreDrives.conf bearbeiten
-##### Ein Eintrag in der ignoreDrives-Datei sorgt dafür das die Software bestimmte Festplatten ignoriert. Dies ist wichtig damit nicht unbeabsichtigt die Systemfestplatte oder weitere Festplatten bearbeitet (gelöscht) werden.
-Beispiel Inhalt:
-```
-/dev/sda:508eff7d-f039-4efb-9e2c-22dffdfdfdfd
-/dev/sdb:07dfffff-c4b6-46e7-9cdf-3cfdfdffd53d
-/dev/sdc:dfff974d-1af2-4dfd-9dfd-a2d8e4c43dff
-```
-Ein Eintrag setzt sich aus zwei Teilen zusammen:
-
-**[Pfad]:[PARTUUID]**
-
-Der Pfad kann mittels `fdisk -l` ermittelt werden.\
-Die PARTUUID kann mittels `blkid /dev/sda` ermittelt werden, wobei `/dev/sda` derzuvor ermittelte Pfad ist.
- 
-# Benutzung
-reHDD starten mit `./reHDD`  (Wichtig ist das reHDD mit root-Rechen ausgeführt wird, entwender als root einloggen oder mit `sudo`)
-
-reHDD sucht automatisch nach allen verfügbaren Festplatten und filtert die zu ignorierenden heraus.\
-Für die verbleibenden Festplatten wird eine Übersicht ausgegeben. 
-Der Nutzer wird gefragt, welche Festplatte bearbeitet werden soll und gibt die Nummer ein.
-
-Beispiel:
-
-```
-hostname@hendrik:/reHDD_prototype # ./reHDD 
-refurbishingHddTool
-created app
-app logic
-search drives ...
-------------DRIVES---------------
-        Drive: 0
-Path:          /dev/sdd
-ModelFamily:   
-ModelName:     ADATA SU650
-Capacity:      120034123776
-Serial:        H50125K001601
-PowerOnHours:  93
-PowerCycle:    187
-ErrorCount:    0
-
----------------------------------
-Select drive to wipe:
-0
-Selected drive index: 0
-wipe: shred -v /dev/sdd
-shred: /dev/sdd: Durchgang 1/3 (random)…
-shred: /dev/sdd: Durchgang 1/3 (random)…847MiB/112GiB 0%
-...
-```