ridgeworks / clpBNR

CLP(BNR) module for SWI-Prolog
MIT License
38 stars 5 forks source link

Packify #8

Closed JanWielemaker closed 3 years ago

JanWielemaker commented 3 years ago

Hi Rick, These changes implement the git organization I would use. This also requires renaming the repo to simply clpBNR. Using this arrangement you can upload a version using the script upload-pack that you find in the scripts directory of the source distribution or at https://github.com/SWI-Prolog/swipl-devel/blob/master/scripts/upload-pack. You need to set GITHUBUSER to ridgeworks

To release a version, simply edit the version in pack.pl, commit and run the above script from within the git working directory. This uses github's release zip archiving. This may require me to update the source location of the package. Alternatively you can register the package using the https git URL, which causes pack install to clone the git repo.

You might consider creating a separate repo for the docs concerning their size. Docs look good!

Pushed some more changes to cleanup usage as a library. I tried to keep the changes small, so you can see what to accept.

ridgeworks commented 3 years ago

Hi Jan,

This is great, just the sort of hand holding I need in my current state of understanding.

To ensure I really understand what I'm doing, I'm going to hand merge these changes into my current local development copy and retest it all before pushing it all back to github. I'll defer separating out the docs for now. It started small but has obviously grown significantly. Due to a fair amount of churn in the past it's been an advantage to keep the software and docs in sync, but I can see a time when that's no longer the case.

One quick question: what's the issue with "Remove printing *** clpBNR v~walpha *** as this may clobber output" ?

Rick

On Jan 14, 2021, at 8:19 AM, Jan Wielemaker notifications@github.com wrote:

Hi Rick, These changes implement the git organization I would use. This also requires renaming the repo to simply clpBNR. Using this arrangement you can upload a version using the script upload-pack that you find in the scripts directory of the source distribution or at https://github.com/SWI-Prolog/swipl-devel/blob/master/scripts/upload-pack https://github.com/SWI-Prolog/swipl-devel/blob/master/scripts/upload-pack. You need to set GITHUBUSER to ridgeworks

To release a version, simply edit the version in pack.pl, commit and run the above script from within the git working directory. This uses github's release zip archiving. This may require me to update the source location of the package. Alternatively you can register the package using the https git URL, which causes pack install to clone the git repo.

You might consider creating a separate repo for the docs concerning their size. Docs look good!

Pushed some more changes to cleanup usage as a library. I tried to keep the changes small, so you can see what to accept.

You can view, comment on, or merge this pull request online at:

https://github.com/ridgeworks/clpBNR_pl/pull/8 https://github.com/ridgeworks/clpBNR_pl/pull/8 Commit Summary

Moved src to prolog and added pack.pl to allow for direct usage as a pack Deleted packed archives from the repo Fixed modes of files to 644 Move helper files to a subdirectory to avoid them being available as direct Remove printing *** clpBNR v~walpha *** as this may clobber output. Cleanup declarations and modularize initialization of the library. Initialize global variables using an exception hook to allow usage File Changes

M docs/CLP_BNR_Guide/CLP_BNR_Guide.html https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-a9ffa008bb7ce69e8469b7ed21e96798c68162ad312cf22173ca4699f5bc317c (0) M docs/CLP_BNR_Guide/CLP_BNR_Guide.myw https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-f1ae0f2506216032ae42d5caf1fd768042cdcc5f6eaf454ead48b6d7229a156a (0) M docs/CLP_BNR_Guide/lib/commonmark.min.js https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-d79f7f7b2af90fb8e9a6673ca74d1335da2cd242a9d1e04df1c5e591343fe488 (0) M docs/CLP_BNR_Guide/lib/grit.js https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-3ebcbaf9cb8a81de68ede8ab57cf741090b18382145459445bc684dd709620fd (0) D docs/Package/clpBNR-0.7.4.zip https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-483f1b750fcd5baac4502c80ce466cca2d9a1873fb1e6a96dcd661f47feeb582 (0) D docs/Package/clpBNR-0.8.1.zip https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-37272aa8151d75f6835fb116670535af004788cd3f661551006a2d3a69ab506f (0) D docs/Package/clpBNR-0.8.2.zip https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-f26b1ff52ceccd27dd3f866cc28b1a5973f41384668079435608214722b40272 (0) D docs/Package/clpBNR-0.8.zip https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-4a34801a066ed7ffc0a1ed317e9240a7e6930bb623bc575fb81dd16acb8a92ca (0) D docs/Package/clpBNR-0.9.0.zip https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-c5e4dc969aa4ef0849d5674ea2d7d321a4d99b10ecf7d0ce2a239b1143af09f0 (0) D docs/Package/clpBNR-0.9.1.zip https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-edb0dcbd4049d28f320895fc288da31da11429c40ab98ab83575f5d76ffff60f (0) D docs/Package/clpBNR-0.9.2.zip https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-e2dc6783f6a56204284e1c82f87221d438db11763c2b249df912759a244d7e48 (0) D docs/Package/clpBNR-0.9.3.zip https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-d3097bd7dc2bf3bd704cc7e9a3b7709187c8b5ef1e989ef66812499a796766d1 (0) D docs/Package/clpBNR-0.9.4.zip https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-c197dcb0b063abfd16bc7ec41d1bca78a839da06851e188dabea67a78a8f64fc (0) R pack.pl https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-721af00738546223e5cb2cda90dd0f10772959e3684ddfc3b2a92511a271f44b (0) R prolog/clpBNR.pl https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-da53d7d62816aad6990f3df6bb4d76bc6592897e4cc7b200f269ac023bfcf858 (169) R prolog/clpBNR/ia_primitives.pl https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-47f9c9a13ccd3c8fd0947b700940cd8c394bcbf69289f4683f56eae309b449cd (0) R prolog/clpBNR/ia_simplify.pl https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-9801fe561a850cf6d253aa0162045242a444758fe1216a40640daecafcf4ec3b (0) R prolog/clpBNR/ia_utilities.pl https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-0bc844e75bfab98f869733e8faaaa2d25b620aba63adfdb6f6993021a76d1d88 (0) D src/clpBNR.pl https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-5f78e57b2e8f138b2a7f51a4e9907a87e41906ea229d1a91afb298babda33012 (825) D src/ia_primitives.pl https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-75f9276e4d71192d139a75f448d92e9347c119190a391743c395d139f24c518c (838) D src/ia_simplify.pl https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-75b246823d2c10683f7dd290315fd8618d4bab70acfbea9714f508e017f8ac90 (386) D src/ia_utilities.pl https://github.com/ridgeworks/clpBNR_pl/pull/8/files#diff-a7c2c0004e9a7568df14762e4be5aaa353dc7f8b837a29a93c103efcee3058c6 (797) Patch Links:

https://github.com/ridgeworks/clpBNR_pl/pull/8.patch https://github.com/ridgeworks/clpBNR_pl/pull/8.patch https://github.com/ridgeworks/clpBNR_pl/pull/8.diff https://github.com/ridgeworks/clpBNR_pl/pull/8.diff — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/ridgeworks/clpBNR_pl/pull/8, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABXFJQJIURVMVADBLKP5UCDSZ3VMJANCNFSM4WCNK2YA.

ridgeworks commented 3 years ago

Suggested structure has been included in clpBNR 0.9.5 with a couple of changes:

  1. clpBNR banner message retained but as informational print_message.
  2. clpBNR globals now always initialized via user:exception, i.e. same for all threads.

Loading as .git works; downside is it includes docs (2+Mbyes) which will probably never be used locally. docs directory cleanup deferred to future cleanup.

Thanks again for detailed input.