Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bug fix and improvements for apply_slac_license.py #1139

Merged
merged 3 commits into from
Feb 23, 2024
Merged

Bug fix and improvements for apply_slac_license.py #1139

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d085165
Wrong indentation was preventing the loop from reaching all files
marciodo Feb 23, 2024
0fd1605
Fixed typo in help message
marciodo Feb 23, 2024
b0e0c02
Provided an optional argument so the user can choose the location of …
marciodo Feb 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 34 additions & 24 deletions scripts/apply_slac_license.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,48 +100,58 @@ def updateFile(path,module,comment,log,script):

# Check args
if len(sys.argv) < 3:
print ("Usage: apply_license.py root_dir module_name")
print ("Usage: apply_slac_license.py root_dir module_name [optional path_to_license]")
exit()

module = sys.argv[2]
path = sys.argv[1]
# Path to license is an optional argument
license_path = ""
if len(sys.argv) == 4:
license_path = sys.argv[3]

logFile = open (path + "/apply_license_log.txt","w")

# Copy license file
baseDir = os.path.realpath(__file__).split('surf')[0]
shutil.copy(baseDir+"surf/LICENSE.txt",path + "/LICENSE.txt")
if license_path != "":
# Use user defined directory
baseDir = os.path.realpath(license_path)
shutil.copy(baseDir + "/LICENSE.txt", path + "/LICENSE.txt")
else:
# Use surf default directory
baseDir = os.path.realpath(__file__).split('surf')[0]
shutil.copy(baseDir + "surf/LICENSE.txt", path + "/LICENSE.txt")

# Walk directories recursively
for root,dirs,files in os.walk(path):
for f in files:
src = "%s/%s" % (root,f)
ret = None

# Skip .svn sub-directories
if f.find(".svn") > 0:
logFile.write("Ignored: %s\n" % (src))
# Skip .svn sub-directories
if f.find(".svn") > 0:
logFile.write("Ignored: %s\n" % (src))

# VHDL
elif f.endswith(".vhd"):
updateFile(src,module,"--",logFile,False)
# VHDL
elif f.endswith(".vhd"):
updateFile(src,module,"--",logFile,False)

# C files
elif f.endswith(".h") or f.endswith(".hh") or f.endswith(".c") or f.endswith(".cc") or f.endswith(".cpp"):
updateFile(src,module,"//",logFile,False)
# C files
elif f.endswith(".h") or f.endswith(".hh") or f.endswith(".c") or f.endswith(".cc") or f.endswith(".cpp"):
updateFile(src,module,"//",logFile,False)

# Verilog, Verilog, or System Verilog
elif f.endswith(".v") or f.endswith(".vh") or f.endswith(".sv"):
updateFile(src,module,"//",logFile,False)
# Verilog, Verilog, or System Verilog
elif f.endswith(".v") or f.endswith(".vh") or f.endswith(".sv"):
updateFile(src,module,"//",logFile,False)

# TCL / XDC
elif f.endswith(".tcl") or f.endswith(".xdc"):
updateFile(src,module,"##",logFile,False)
# TCL / XDC
elif f.endswith(".tcl") or f.endswith(".xdc"):
updateFile(src,module,"##",logFile,False)

# Python
elif f.endswith(".py"):
updateFile(src,module,"##",logFile,True)
# Python
elif f.endswith(".py"):
updateFile(src,module,"##",logFile,True)

# Unknown
else:
logFile.write("Unknown: %s\n" % (src))
# Unknown
else:
logFile.write("Unknown: %s\n" % (src))
Loading