|
|
|
|
245
|
echo "everything, so few things still need to be done manually."
|
245
|
echo "everything, so few things still need to be done manually."
|
246
|
echo "This document will guide you throught the rest of the"
|
246
|
echo "This document will guide you throught the rest of the"
|
247
|
echo "process."
|
247
|
echo "process."
|
248
|
-
|
|
|
249
|
echo ""
|
248
|
echo ""
|
250
|
echo ""
|
249
|
echo ""
|
251
|
echo "Structure"
|
250
|
echo "Structure"
|
|
|
|
|
293
|
echo " idea!), be prepared that you will need to follow their"
|
292
|
echo " idea!), be prepared that you will need to follow their"
|
294
|
echo " guidelines. This will most probably mean huge changes"
|
293
|
echo " guidelines. This will most probably mean huge changes"
|
295
|
echo " to these packages or even changes to your workflow."
|
294
|
echo " to these packages or even changes to your workflow."
|
296
|
-
|
|
|
297
|
echo ""
|
295
|
echo ""
|
298
|
echo ""
|
296
|
echo ""
|
299
|
echo "Placeholders"
|
297
|
echo "Placeholders"
|
|
|
|
|
357
|
echo " Typical example of a role is e.g. 'bin' for commands"
|
355
|
echo " Typical example of a role is e.g. 'bin' for commands"
|
358
|
echo " (normally under '/usr/bin' or '/usr/local/bin'), 'doc'"
|
356
|
echo " (normally under '/usr/bin' or '/usr/local/bin'), 'doc'"
|
359
|
echo " for documents or 'lib' for libraries."
|
357
|
echo " for documents or 'lib' for libraries."
|
360
|
-
|
|
|
361
|
echo ""
|
358
|
echo ""
|
362
|
echo " 2. Next, in \`[roots]\` section, you have to set target"
|
359
|
echo " 2. Next, in \`[roots]\` section, you have to set target"
|
363
|
echo " root directory for each role. However, in order to"
|
360
|
echo " root directory for each role. However, in order to"
|
|
|
|
|
366
|
echo " environment variable. For this reason, most paths"
|
363
|
echo " environment variable. For this reason, most paths"
|
367
|
echo " need to start with \`[ENV:PREFIX]\`."
|
364
|
echo " need to start with \`[ENV:PREFIX]\`."
|
368
|
echo ""
|
365
|
echo ""
|
369
|
-
|
|
|
370
|
echo " 3. \`[files]\` section is where you assign actual files"
|
366
|
echo " 3. \`[files]\` section is where you assign actual files"
|
371
|
echo " from your repository to their final paths. The format"
|
367
|
echo " from your repository to their final paths. The format"
|
372
|
echo " is \`ROLE = REPOPATH [RENAMED]\`, where ROLE is file's"
|
368
|
echo " is \`ROLE = REPOPATH [RENAMED]\`, where ROLE is file's"
|
|
|
|
|
381
|
echo " individually, if in your repo you have a directory with"
|
377
|
echo " individually, if in your repo you have a directory with"
|
382
|
echo " 100 files of the same role, you can add just path to the"
|
378
|
echo " 100 files of the same role, you can add just path to the"
|
383
|
echo " directory itself."
|
379
|
echo " directory itself."
|
384
|
-
|
|
|
385
|
echo ""
|
380
|
echo ""
|
386
|
echo " 4. If some roles require special permissions on your files,"
|
381
|
echo " 4. If some roles require special permissions on your files,"
|
387
|
echo " \`[modes]\` section is your friend. Permissions here"
|
382
|
echo " \`[modes]\` section is your friend. Permissions here"
|
388
|
echo " should be in UNIX octal format."
|
383
|
echo " should be in UNIX octal format."
|
389
|
-
|
|
|
390
|
echo ""
|
384
|
echo ""
|
391
|
echo " 5. Next, \`[tokens]\` section allows you to define own"
|
385
|
echo " 5. Next, \`[tokens]\` section allows you to define own"
|
392
|
echo " placeholders that will be replaced when your scripts are"
|
386
|
echo " placeholders that will be replaced when your scripts are"
|
|
|
|
|
396
|
echo " defined here, plus range of tokens automatically defined"
|
390
|
echo " defined here, plus range of tokens automatically defined"
|
397
|
echo " by MKit. During build, these tokens are replaced with"
|
391
|
echo " by MKit. During build, these tokens are replaced with"
|
398
|
echo " their actual values."
|
392
|
echo " their actual values."
|
399
|
-
|
|
|
400
|
echo ""
|
393
|
echo ""
|
401
|
echo " 6. Less interesting, but important section is \`[dist]\`,"
|
394
|
echo " 6. Less interesting, but important section is \`[dist]\`,"
|
402
|
echo " which lists files in your codebase that will be added"
|
395
|
echo " which lists files in your codebase that will be added"
|
|
|
|
|
404
|
echo " above). Listing directory here will include all its"
|
397
|
echo " above). Listing directory here will include all its"
|
405
|
echo " contents, and normally it's OK to be very inclusive, so"
|
398
|
echo " contents, and normally it's OK to be very inclusive, so"
|
406
|
echo " most of the time this section should be OK."
|
399
|
echo " most of the time this section should be OK."
|
407
|
-
|
|
|
408
|
echo ""
|
400
|
echo ""
|
409
|
echo " 7. Even less interesting is section \`[ENV]\`. It is"
|
401
|
echo " 7. Even less interesting is section \`[ENV]\`. It is"
|
410
|
echo " special in that it provides *default* value for an"
|
402
|
echo " special in that it provides *default* value for an"
|
411
|
echo " environment variable. You almost never need to touch"
|
403
|
echo " environment variable. You almost never need to touch"
|
412
|
echo " this."
|
404
|
echo " this."
|
413
|
echo ""
|
405
|
echo ""
|
414
|
-
|
|
|
415
|
echo " 8. Finally, the most interesting section! \`[project]\`,"
|
406
|
echo " 8. Finally, the most interesting section! \`[project]\`,"
|
416
|
echo " provides most general information for your project such"
|
407
|
echo " provides most general information for your project such"
|
417
|
echo " as name and version."
|
408
|
echo " as name and version."
|