summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDominique Dumont <dod@debian.org>2021-04-11 17:50:03 +0200
committerDominique Dumont <dod@debian.org>2021-04-11 17:50:03 +0200
commit696b5009cce40ecdbc075aacbbfae13e26f7f0cd (patch)
tree73a0f3e48c4969ba049b9f7f245d8aeaf6cb6f82
parentf0dcb2dac14664224ef634a9702feadff7b411d6 (diff)
translated t/scanner/README in org-mode file
-rw-r--r--t/scanner/README.md27
-rw-r--r--t/scanner/README.org30
2 files changed, 30 insertions, 27 deletions
diff --git a/t/scanner/README.md b/t/scanner/README.md
deleted file mode 100644
index 2f2fd432..00000000
--- a/t/scanner/README.md
+++ /dev/null
@@ -1,27 +0,0 @@
-New examples are created in 2 steps.
-
-First create the .in file
-
-Say you want to create a test from package `foo`.
-
-set these variables:
-
- # create .in file
- # in libconfig-model-dpkg-perl repo
- export TEST=foo_test
- export repo_dir=$PWD
- cd path_to_foo
- licensecheck --encoding utf8 --copyright --machine --deb-fmt --recursive . > $repo_dir/t/scanner/examples/$TEST.in
-
- # create .out file
- cd - # back to libconfig-model-dpkg-perl repo
- perl -Ilib bin/scan-copyrights t/scanner/examples/$TEST.in > t/scanner/examples/$TEST.out
-
-The .out files may need to be regenated if lib/Dpkg/Copyright/Scanner.pm is changed.
-Use a similar command to do so:
-
- export TEST=bar
- perl -Ilib bin/scan-copyrights t/scanner/examples/$TEST.in > t/scanner/examples/$TEST.out
-
-Be sure to check that the updated output makes sense
-
diff --git a/t/scanner/README.org b/t/scanner/README.org
new file mode 100644
index 00000000..d45e9e03
--- /dev/null
+++ b/t/scanner/README.org
@@ -0,0 +1,30 @@
+New examples are created in 2 steps.
+
+First create the .in file
+
+Say you want to create a test from package =foo=.
+
+set these variables:
+
+#+BEGIN_EXAMPLE
+ # create .in file
+ # in libconfig-model-dpkg-perl repo
+ export TEST=foo_test
+ export repo_dir=$PWD
+ cd path_to_foo
+ licensecheck --encoding utf8 --copyright --machine --deb-fmt --recursive . > $repo_dir/t/scanner/examples/$TEST.in
+
+ # create .out file
+ cd - # back to libconfig-model-dpkg-perl repo
+ perl -Ilib bin/scan-copyrights t/scanner/examples/$TEST.in > t/scanner/examples/$TEST.out
+#+END_EXAMPLE
+
+The .out files may need to be regenated if lib/Dpkg/Copyright/Scanner.pm
+is changed. Use a similar command to do so:
+
+#+BEGIN_EXAMPLE
+ export TEST=bar
+ perl -Ilib bin/scan-copyrights t/scanner/examples/$TEST.in > t/scanner/examples/$TEST.out
+#+END_EXAMPLE
+
+Be sure to check that the updated output makes sense