[tor-commits] [tor-browser-build/master] Bug 40283: Move all documentation to the doc directory

sysrqb at torproject.org sysrqb at torproject.org
Fri Apr 30 16:17:01 UTC 2021 

commit 8345837ad4bb81f619fee93bb81dfdc46ceb06d4
Author: Nicolas Vigier <boklm at torproject.org>
Date:   Tue Apr 20 18:26:14 2021 +0200

    Bug 40283: Move all documentation to the doc directory
---
 README                                                             | 7 +++----
 README.BUILD_ERRORS => doc/BUILD_ERRORS.txt                        | 0
 README.HACKING => doc/HACKING.txt                                  | 0
 README.MAKEFILE => doc/MAKEFILE.txt                                | 0
 .../common => doc}/how-to-create-gradle-dependencies-list.txt      | 0
 {projects/common => doc}/how-to-update-glean-parser.txt            | 0
 doc/rbm                                                            | 1 +
 projects/android-components/gradle-dependencies-list.txt           | 2 +-
 projects/application-services/gradle-dependencies-list.txt         | 2 +-
 projects/common/gen_gradle_deps_file.sh                            | 4 ++--
 projects/fenix/gradle-dependencies-list.txt                        | 2 +-
 projects/geckoview/gradle-dependencies-list.txt                    | 2 +-
 projects/tor-android-service/gradle-dependencies-list.txt          | 2 +-
 projects/tor-onion-proxy-library/gradle-dependencies-list.txt      | 2 +-
 14 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/README b/README
index 1582743..5407b0c 100644
--- a/README
+++ b/README
@@ -212,20 +212,19 @@ with the following command:
 Common Build Errors
 -------------------
 
-You can look at the README.BUILD_ERRORS file for a list of common build
+You can look at the file doc/BUILD_ERRORS.txt for a list of common build
 errors and their solutions.
 
 
 Hacking on the Tor Browser build
 --------------------------------
 
-The file README.HACKING tries to list the main things to know when
+The file doc/HACKING.txt tries to list the main things to know when
 making changes to the Tor Browser build.
 
 
 Description of makefile rules
 -----------------------------
 
-You can find a description of the Makefile rules in the README.MAKEFILE
-file.
+You can find a description of the Makefile rules in the file doc/MAKEFILE.txt.
 
diff --git a/README.BUILD_ERRORS b/doc/BUILD_ERRORS.txt
similarity index 100%
rename from README.BUILD_ERRORS
rename to doc/BUILD_ERRORS.txt
diff --git a/README.HACKING b/doc/HACKING.txt
similarity index 100%
rename from README.HACKING
rename to doc/HACKING.txt
diff --git a/README.MAKEFILE b/doc/MAKEFILE.txt
similarity index 100%
rename from README.MAKEFILE
rename to doc/MAKEFILE.txt
diff --git a/projects/common/how-to-create-gradle-dependencies-list.txt b/doc/how-to-create-gradle-dependencies-list.txt
similarity index 100%
rename from projects/common/how-to-create-gradle-dependencies-list.txt
rename to doc/how-to-create-gradle-dependencies-list.txt
diff --git a/projects/common/how-to-update-glean-parser.txt b/doc/how-to-update-glean-parser.txt
similarity index 100%
rename from projects/common/how-to-update-glean-parser.txt
rename to doc/how-to-update-glean-parser.txt
diff --git a/doc/rbm b/doc/rbm
new file mode 120000
index 0000000..aaaec74
--- /dev/null
+++ b/doc/rbm
@@ -0,0 +1 @@
+../rbm/doc
\ No newline at end of file
diff --git a/projects/android-components/gradle-dependencies-list.txt b/projects/android-components/gradle-dependencies-list.txt
index ab3da10..1ae9cb9 100644
--- a/projects/android-components/gradle-dependencies-list.txt
+++ b/projects/android-components/gradle-dependencies-list.txt
@@ -1,4 +1,4 @@
-# On how to update dependencies see projects/common/how-to-create-gradle-dependencies-list.txt
+# On how to update dependencies see doc/how-to-create-gradle-dependencies-list.txt
 # Don't forget to update var/gradle_dependencies_version when modifying this file
 sha256sum | url
 d1bc9842455c2e534415d88c44df4d52413b478db9093a1ba36324f705f44c3d | https://dl.google.com/dl/android/maven2/androidx/activity/activity/1.0.0/activity-1.0.0.aar
diff --git a/projects/application-services/gradle-dependencies-list.txt b/projects/application-services/gradle-dependencies-list.txt
index bd001d9..8686f74 100644
--- a/projects/application-services/gradle-dependencies-list.txt
+++ b/projects/application-services/gradle-dependencies-list.txt
@@ -1,4 +1,4 @@
-# On how to update dependencies see projects/common/how-to-create-gradle-dependencies-list.txt
+# On how to update dependencies see doc/how-to-create-gradle-dependencies-list.txt
 # Don't forget to update var/gradle_dependencies_version when modifying this file
 sha256sum | url
 d1bc9842455c2e534415d88c44df4d52413b478db9093a1ba36324f705f44c3d | https://dl.google.com/dl/android/maven2/androidx/activity/activity/1.0.0/activity-1.0.0.aar
diff --git a/projects/common/gen_gradle_deps_file.sh b/projects/common/gen_gradle_deps_file.sh
index 99d0517..3ea8f16 100755
--- a/projects/common/gen_gradle_deps_file.sh
+++ b/projects/common/gen_gradle_deps_file.sh
@@ -32,7 +32,7 @@
 
 # Usage:
 # 1) Point to a log file with all the dependency download attempts (for its
-#    generation see: projects/common/how-to-create-gradle-dependencies-list.txt)
+#    generation see: doc/how-to-create-gradle-dependencies-list.txt)
 # 2) Double-check that you get the same SHA-256 sums when downloaded from a
 #    different network location. E.g. by using `torsocks` with this script after
 #    having made a copy of `gradle-dependencies-list.txt` from 1) and comparing
@@ -57,7 +57,7 @@ do
 done < dl-attempts
 
 # Step 3: Add the header at the beginning of the final dependency file.
-echo "# On how to update dependencies see projects/common/how-to-create-gradle\
+echo "# On how to update dependencies see doc/how-to-create-gradle\
 -dependencies-list.txt" > gradle-dependencies-list.txt
 echo "# Don't forget to update var/gradle_dependencies_version when modifying \
 this file" >> gradle-dependencies-list.txt
diff --git a/projects/fenix/gradle-dependencies-list.txt b/projects/fenix/gradle-dependencies-list.txt
index 1cbaeee..a172735 100644
--- a/projects/fenix/gradle-dependencies-list.txt
+++ b/projects/fenix/gradle-dependencies-list.txt
@@ -1,4 +1,4 @@
-# On how to update dependencies see projects/common/how-to-create-gradle-dependencies-list.txt
+# On how to update dependencies see doc/how-to-create-gradle-dependencies-list.txt
 # Don't forget to update var/gradle_dependencies_version when modifying this file
 sha256sum | url
 1996c36d3d2d62db5020b8ec634b5f854b1a698960c3552e1a00c69221baeabe | https://dl.google.com/dl/android/maven2/androidx/activity/activity-ktx/1.1.0/activity-ktx-1.1.0.aar
diff --git a/projects/geckoview/gradle-dependencies-list.txt b/projects/geckoview/gradle-dependencies-list.txt
index f429a3a..1d73d70 100644
--- a/projects/geckoview/gradle-dependencies-list.txt
+++ b/projects/geckoview/gradle-dependencies-list.txt
@@ -1,4 +1,4 @@
-# On how to update dependencies see projects/common/how-to-create-gradle-dependencies-list.txt
+# On how to update dependencies see doc/how-to-create-gradle-dependencies-list.txt
 # Don't forget to update var/gradle_dependencies_version when modifying this file
 sha256sum | url
 857db5645aaefbd7fbe9ba6454b072bc0518ebaba08a93d5eae89a9850e949c4 | https://jcenter.bintray.com/com/getkeepsafe/dexcount/dexcount-gradle-plugin/0.8.2/dexcount-gradle-plugin-0.8.2.jar
diff --git a/projects/tor-android-service/gradle-dependencies-list.txt b/projects/tor-android-service/gradle-dependencies-list.txt
index 9adfa6b..5109de6 100644
--- a/projects/tor-android-service/gradle-dependencies-list.txt
+++ b/projects/tor-android-service/gradle-dependencies-list.txt
@@ -1,4 +1,4 @@
-# On how to update dependencies see projects/common/how-to-create-gradle-dependencies-list.txt
+# On how to update dependencies see doc/how-to-create-gradle-dependencies-list.txt
 # Don't forget to update var/gradle_dependencies_version when modifying this file
 sha256sum | url
 3a616a32f433e9e23f556b38575c31b013613d3ae85206263b7625fe1f4c151a | https://dl.google.com/dl/android/maven2/android/arch/core/common/1.1.1/common-1.1.1.jar
diff --git a/projects/tor-onion-proxy-library/gradle-dependencies-list.txt b/projects/tor-onion-proxy-library/gradle-dependencies-list.txt
index 1612a54..5260377 100644
--- a/projects/tor-onion-proxy-library/gradle-dependencies-list.txt
+++ b/projects/tor-onion-proxy-library/gradle-dependencies-list.txt
@@ -1,4 +1,4 @@
-# On how to update dependencies see projects/common/how-to-create-gradle-dependencies-list.txt
+# On how to update dependencies see doc/how-to-create-gradle-dependencies-list.txt
 # Don't forget to update var/gradle_dependencies_version when modifying this file
 sha256sum | url
 3a616a32f433e9e23f556b38575c31b013613d3ae85206263b7625fe1f4c151a | https://dl.google.com/dl/android/maven2/android/arch/core/common/1.1.1/common-1.1.1.jar

More information about the tor-commits mailing list