Skip to content

Commit 27af03d

Browse files
committed
Add comments about subdirectory
1 parent d44c2fd commit 27af03d

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

import-added-ocaml-source-files.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ Fetches any new files that previously hadn't been imported. This ignores
1818
files outside of *directories* that were previously imported,
1919
so if a whole new directory is added, you may need to manually
2020
add the new file.
21+
22+
See usage information for ./import-ocaml-source.sh for more info about
23+
the subdirectory arguments.
2124
USAGE
2225
}
2326

import-ocaml-source.sh

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ This attempts to import new files from the compiler by running the
2323
try making matched pairs of files in this repository with the right names: one
2424
in "upstream/ocaml_flambda/", and one in "src/ocaml". Then running the script
2525
will pull in the named file(s).
26+
27+
The SUBDIRECTORY argument is useful when importing from a repository that buries
28+
the relevant compiler files inside a subdirectory. This used to be the case for
29+
flambda (files were under an "ocaml/" direcotry), although it is no longer the
30+
case. The OLD_SUBDIRECTORY argument is useful for when the directory structure
31+
has changed since the last import.
2632
USAGE
2733
}
2834

@@ -50,6 +56,8 @@ fi
5056

5157
if [[ $# -le 4 ]]; then
5258
repository="${2-$repository}"
59+
# Although the subdirectory arguments are probably no longer useful, it doesn't hurt
60+
# to keep them around in case they ever are of use.
5361
subdirectory="${3-$subdirectory}"
5462
old_subdirectory="${4-$old_subdirectory}"
5563
else

0 commit comments

Comments
 (0)