NightOwl888 commented on code in PR #1067:
URL: https://github.com/apache/lucenenet/pull/1067#discussion_r1891130858


##########
src/Lucene.Net/Util/Packed/README.md:
##########
@@ -0,0 +1,28 @@
+# Lucene.Net.Util.Packed
+
+## Generating the files
+
+There are four Python scripts in this folder:
+[`gen_BulkOperation.py`](gen_BulkOperation.py),
+[`gen_Direct.py`](gen_Direct.py),
+[`gen_Packed64SingleBlock.py`](gen_Packed64SingleBlock.py), and
+[`gen_PackedThreeBlocks.py`](gen_PackedThreeBlocks.py).
+These scripts were ported from the original Lucene 4.8.1 code, and modified to 
generate the corresponding C# code instead of Java.
+
+To generate the files, run the following commands from this directory:

Review Comment:
   Good point about installing Python3 on Windows. Although, this is exactly 
what you need to go through to setup dotnet/runtime to build (along with 
several other dependencies), it is just a matter of having decent documentation 
for the developer setup process.
   
   There are also other code generation scripts to port, some of which use 
Python.
   
   That being said, I think we could probably skip all of that for the time 
being and change the CI builds (especially GitHub Actions) so they generate the 
files and then use Git to determine if there are any changes to them. If a 
generated file doesn't match the repository, fail the build. This would catch 
both cases:
   
   1. The script changed and the files weren't regenerated and committed
   2. One or more of the generated files was manually changed
   
   If we do that, the normal build for developers wouldn't need to change and 
we wouldn't have to manually check to ensure things didn't get out of sync.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to