Design log mess

[muhammadaliog3]

Closes #2173

Some of the important logs.

First match ode log
designLog.txt

Not first match ode log
designLog.txt

Code Concept match
designLog.txt

[smiths]

There should only be one period at the end of the sentence.

[smiths]

There should only be one period at the end of the sentence.

[smiths]

There should only be one period at the end of the sentence.

[smiths]

Shouldn't the language say cpp? The other languages have their own folders, where the selected language would correspond to the folder.

[smiths]

I like the design logs. This will be very handy in the future, since at present, we rely on the naming conventions to remind us what variabilities are selected.

I noticed some minor issues with the generated logs. I added comments to the commit related to these issues.

I have not reviewed how you generated the logs.

[JacquesCarette]

@smiths the merge is blocked because you have to acknowledge whether the changes that you asked for have indeed been done.

[muhammadaliog3]

Actually we should wait till the end of this week. Although stable has the design logs, the make rule has yet to be updated to compare the generated design logs. So until the changes are made to scripts we should not merge the request.

[smiths]

I agree with @muhammadaliog3 that we should wait until everything is done. I just looked at the design logs in stable and they still have the extra periods.

[Nathaniel-Hu]

I've been looking at how I would need to modify the Makefile rules to include the design logs as files to be tested/compared with the files in the stable version. However, I've noticed that the Makefile rule used to compare generated files with their stable counterparts is instructed to ignore .txt files (of which the design logs are). Is there a way to modify this rule to not ignore the design log files somehow? @JacquesCarette @smiths @Mornix

The following is an example of the Makefile commands used to compare generated and stable files and push differences to the log files.

cd "build/GlassBR" && stack exec -- "glassbr" 
diff --strip-trailing-cr -r -X ../.gitignore -x '*.txt' "stable/glassbr/" "build/GlassBR"/ > "logs/GlassBR_log.log" 2>&1

[smiths]

The changes I requested were made, so I unblocked my review. However, @muhammadaliog3 mentioned that a make rule still had to be updated. I don't know if that update was made.

[JacquesCarette]

Even though there are some small tweaks that could still be done, this is better merged in than waiting forever.