aboutsummaryrefslogtreecommitdiff
path: root/libbutl-odb/README-DEV
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2024-05-06 06:33:36 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2024-05-06 07:48:52 +0200
commit6b61bd245870bad80a2655ea4c4b56d1246233df (patch)
tree0ddf9d148b31c6d6f16dc49107d6826151f4872d /libbutl-odb/README-DEV
parent78a1f350d9b6483997886d7438504d2a75498f68 (diff)
Add libbutl-odb source subdirectory
This is an additional (to libbutl) utility library which contains the source code of libodb, libodb-sqlite, and libsqlite3 configured and tuned for our needs.
Diffstat (limited to 'libbutl-odb/README-DEV')
-rw-r--r--libbutl-odb/README-DEV40
1 files changed, 40 insertions, 0 deletions
diff --git a/libbutl-odb/README-DEV b/libbutl-odb/README-DEV
new file mode 100644
index 0000000..f058901
--- /dev/null
+++ b/libbutl-odb/README-DEV
@@ -0,0 +1,40 @@
+Excluded/replaced/relocated ODB upstream files/directories:
+ - libodb/odb/tr1/
+ - libodb/odb/buildfile
+ - libodb/odb/details/{condition.cxx lock.cxx mutex.cxx thread.cxx}
+ - libodb/odb/details/posix/
+ - libodb/odb/details/win32/* except for windows.hxx
+
+
+ - libodb/odb/sqlite/buildfile
+ - libodb/odb/sqlite/details/.gitignore
+ - libodb/odb/sqlite/details/options.cli
+ - libodb/odb/sqlite/details/pregenerated/ -- symlink options.?xx directly in details/
+
+ - libodb/odb/version.hxx.in
+ - libodb/odb/sqlite/version.hxx.in
+ - libodb/odb/version.hxx -- replace with pre-generated for submodule commit
+ - libodb/odb/sqlite/version.hxx -- replace with pre-generated for submodule commit
+
+SQLite is placed into a subdirectory to support the use of external version
+(in which case we omit the corresponding -I option).
+
+Submodule update procedure (similar to updating to a new version of a
+third-party package):
+
+1. Update submodule:
+
+ https://build2.org/stage/build2-toolchain/doc/build2-toolchain-packaging.xhtml#core-version-management-new-version-submodule
+
+2. Review upstream changes:
+
+ https://build2.org/stage/build2-toolchain/doc/build2-toolchain-packaging.xhtml#core-version-management-new-version-review
+
+ Look for:
+
+ - files to add/remove (see above)
+ - changes to buildfiles that would need to be replicated
+
+3. Replace verison.hxx with pre-generated for this submodule commit.
+
+4. Review .gitattributes for any symlink=dir changes.