Feat: Automate building of manpages #31
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
luarss
commented
Jul 11, 2024
luarss
force-pushed
the
feat/scrape-manpage
branch
3 times, most recently
from
a913157
to
105b227
Compare
Signed-off-by: Jack Luar <[email protected]>
Signed-off-by: Jack Luar <[email protected]>
Signed-off-by: Jack Luar <[email protected]>
Signed-off-by: Jack Luar <[email protected]>
luarss
force-pushed
the
feat/scrape-manpage
branch
from
d042ec5
to
de5a8e6
Compare
Signed-off-by: Jack Luar <[email protected]>
vvbandeira
approved these changes
Jul 15, 2024
Comment on lines
+80
to
+89
| # clone repo | ||
| or_url = 'https://github.com/The-OpenROAD-Project/OpenROAD' | ||
| cur_dir = os.path.dirname(os.path.realpath(__file__)) | ||
| target_dir = os.path.join(cur_dir, 'OpenROAD') | ||
| command = f"git clone {or_url} --depth 1 {target_dir}" | ||
| res = subprocess.run(command, shell=True, capture_output=True) | ||
| if res.returncode != 0: | ||
| print(f"Error in cloning OpenROAD: {res.stderr.decode('utf-8')}") | ||
| sys.exit(1) | ||
| print('Cloned OpenROAD successfully.') |
There was a problem hiding this comment.
I would break this into a function.
Comment on lines
+91
to
+114
| # check if pandoc is installed, if not error out. | ||
| res = subprocess.run('pandoc --version', shell=True, capture_output=True) | ||
| if res.returncode != 0: | ||
| print('Pandoc is not installed. Please install it.') | ||
| sys.exit(1) | ||
| print('Pandoc is installed.') | ||
|
|
||
| # generate manpages | ||
| command = '../../etc/find_messages.py > messages.txt' | ||
| for module in os.listdir(os.path.join(cur_dir, 'OpenROAD/src')): | ||
| path = os.path.join(cur_dir, 'OpenROAD/src', module) | ||
| if not os.path.isdir(path): | ||
| continue | ||
| print('Processing module:', module) | ||
| os.chdir(path) | ||
| res = subprocess.run(command, shell=True, capture_output=True) | ||
| if res.returncode != 0: | ||
| print(f"Error in finding messages for {module}: {res.stderr.decode('utf-8')}") | ||
| continue | ||
| os.chdir(os.path.join(cur_dir, 'OpenROAD/docs')) | ||
| num_cores = os.cpu_count() | ||
| command = f"make clean && make preprocess && make -j{num_cores}" | ||
| res = subprocess.run(command, shell=True, capture_output=True) | ||
| print('Finished building manpages.') |
There was a problem hiding this comment.
This would be another function
Comment on lines
+116
to
+132
| # copy folder contents to data/markdown/manpages | ||
| src_dir = os.path.join(cur_dir, 'OpenROAD/docs/md') | ||
| dest_dir = os.path.join(cur_dir, 'data/markdown/manpages') | ||
| shutil.copytree(src_dir, dest_dir, dirs_exist_ok=True) | ||
| print('Copied manpages to data/markdown/manpages.') | ||
|
|
||
| # update source_dict | ||
| for root, _, files in os.walk(dest_dir): | ||
| for file in files: | ||
| file_path = os.path.join(root, file) | ||
| file_name = os.path.basename(file_path) | ||
| source_dict[file_path] = file_name | ||
|
|
||
| # change back to the file directory | ||
| os.chdir(cur_dir) | ||
| shutil.rmtree('OpenROAD') | ||
| print('Removed OpenROAD temp directory.') |
There was a problem hiding this comment.
This would be another function.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #7