idea-fasoc/OpenFASOC

Generated Files Are Not Gitignored In Some Generators

Closed this issue · 8 comments

harshkhandeparkar commented

Generated files such as .log, .rpt, .odb in flow/, work/, and simulations/run/ are not gitignored for the following generators:

  1. LDO: No files are gitignored
  2. Temperature Sensor: simulations/run/ is not gitignored.
harshkhandeparkar commented

I was going through the documentation and came across this while running the LDO generator.
I am currently learning about the tool and hoping to contribute in the future so may I work on a fix for this?

lulu9312 commented

@harshkhandeparkar Sure! you can work on fixing this issue.

  • 👍1
harshkhandeparkar commented

I also found that some generated files which were not gitignored are tracked. Should I also untrack these files?

Example: Generated verilog files in ldo-gen and dcdc-gen

saicharan0112 commented

@lulu9312 can you check if we need to prevent these files from version control?

saicharan0112 commented

@harshkhandeparkar I don't think excluding the folders and files you mentioned is a good idea. Intended users are designers and as far as I know, usually they want these files under version control

lulu9312 commented

@saicharan0112 The folders that are generated such as logs/ results/ will change everytime the generator is run. So I think those files should not be pushed to github because anyway when running the flow again the files will be created again.

harshkhandeparkar commented

@harshkhandeparkar I don't think excluding the folders and files you mentioned is a good idea. Intended users are designers and as far as I know, usually they want these files under version control

There are templates (which are pushed) for generating these files and they are generated everytime the generator is run and change slightly depending on the configuration. Also there are nearly a hundred files that are generated so I don't think pushing these is a good idea.

saicharan0112 commented

I was going through the documentation and came across this while running the LDO generator. I am currently learning about the tool and hoping to contribute in the future so may I work on a fix for this?

I really appreciate your interest. Can you look at this issue? It would be really wonderful if you can help with this? #37