4 Commits

Author SHA1 Message Date
  Alois Mahdal 9424d2ee01 Update URLs after migrating to GitLab 1 year ago
  Alois Mahdal 4bdc22641b Clarify some texts a bit 1 year ago
  Alois Mahdal f38bbb73f7 Consistently use 'relics' term instead of 'artifacts' 1 year ago
  Alois Mahdal 0e72b192bb Fix few randomly spotted typos 1 year ago
1 changed files with 24 additions and 22 deletions
  1. 24
    22
      guidelines/hierarchy.md

+ 24
- 22
guidelines/hierarchy.md View File

@@ -72,11 +72,13 @@ Your test suite goes here.  How to structure files under this directory
72 72
 will most probably depend on the test framework you use.
73 73
 
74 74
 
75
-### artifacts ###
75
+### relics ###
76 76
 
77
-If your test suite creates files that you usually need to review,
78
-this is a good place.  Subdirectories here should bear a timestamp in
79
-a human-readable and sortable timestamp format (such as ISO 8601).
77
+Place for locally ran tests to drop any results, reports and intermediate
78
+files that would be useful for investigating test failures.
79
+
80
+Subdirectories here should bear a timestamp in a human-readable and
81
+sortable timestamp format (such as ISO 8601).
80 82
 
81 83
 Note that normally this directory will never exist in a freshly cloned
82 84
 repository and it's likely to be excluded from version control system
@@ -86,13 +88,13 @@ via file such as *.gitignore*.
86 88
 ### notes ###
87 89
 
88 90
 Documentation related to your project.  Evertything from guidelines to
89
-newcomer howtos, style guides, design notes, philpsophy articles...
91
+newcomer howtos, style guides, design notes, philosophy articles...
90 92
 
91 93
 
92 94
 ### utils ###
93 95
 
94 96
 Any build scripts and utilities that are only useful for your project
95
-developers and testers.
97
+developers, maintainers and testers.
96 98
 
97 99
 
98 100
 ### packaging ###
@@ -106,7 +108,7 @@ e.g. creating unofficial .deb files.
106 108
 
107 109
 [MKit][1] already provides features that can help generate such files.
108 110
 
109
-  [1]: https://github.com/AloisMahdal/mkit
111
+  [1]: https://gitlab.com/vornet/infra/mkit
110 112
 
111 113
 
112 114
 Example
@@ -118,19 +120,6 @@ A "living" example: [shellfu][2]:
118 120
     ├── LICENSE             # \
119 121
     ├── Makefile            #  Pretty much standard files...
120 122
     ├── README.md           # /
121
-    ├── artifacts
122
-    │   ├── artifacts-inigrep_inigrep-20161202-073432
123
-    │   │   ├── TF_ENUMERATED_SUBTESTS
124
-    │   │   ├── TF_FILTERED_SUBTESTS
125
-    │   │   ├── TF_RUN
126
-    │   │   ├── oracle      # \
127
-    │   │   │   └── ...     #   artifacts are now huge since 
128
-    │   │   ├── result      #   I ran a lot of tests recently
129
-    │   │   │   └── ...     # /
130
-    │   │   └── test
131
-    │   │       └── ...
132
-    │   └── artifacts-shellfu_api-20161202-081440
133
-    │       └── ...
134 123
     ├── mkit.ini            # <- MKit meta-data file
135 124
     ├── notes               # <- my design notes, although
136 125
     │   └── style.md        #    most are still in my head :)
@@ -140,6 +129,19 @@ A "living" example: [shellfu][2]:
140 129
     │   │   ├── control     #   alpha RPMs and .deb's
141 130
     │   │   └── ...         #   (so far, probably for good)
142 131
     │   └── shellfu.spec    # /
132
+    ├── relics
133
+    │   ├── relics-inigrep_inigrep-20161202-073432
134
+    │   │   ├── TF_ENUMERATED_SUBTESTS
135
+    │   │   ├── TF_FILTERED_SUBTESTS
136
+    │   │   ├── TF_RUN
137
+    │   │   ├── oracle      # \
138
+    │   │   │   └── ...     #   relics are now huge since 
139
+    │   │   ├── result      #   I ran a lot of tests recently
140
+    │   │   │   └── ...     # /
141
+    │   │   └── test
142
+    │   │       └── ...
143
+    │   └── relics-shellfu_api-20161202-081440
144
+    │       └── ...
143 145
     ├── src
144 146
     │   ├── bin                     # \
145 147
     │   │   ├── shellfu-doc         #   here most of the "meat" lives,
@@ -148,7 +150,7 @@ A "living" example: [shellfu][2]:
148 150
     │   ├── complete.bash           #
149 151
     │   ├── include-bash            #   notice that tree here does
150 152
     │   │   └── ...                 #   not attempt to strictly follow
151
-    │   ├── include-sh              #   final placement, jsut hinting
153
+    │   ├── include-sh              #   final placement, just hinting
152 154
     │   │   └── ...                 #   is enough
153 155
     │   └── shellfu.sh.skel         # /
154 156
     ├── tests                   # \
@@ -166,4 +168,4 @@ A "living" example: [shellfu][2]:
166 168
         └── tfkit       #   from the suite (they meet often, though ;))
167 169
             └── ...     # /
168 170
 
169
-  [2]: https://github.com/AloisMahdal/shellfu
171
+  [2]: https://gitlab.com/vornet/shellfu/shellfu