OpenROAD icon indicating copy to clipboard operation
OpenROAD copied to clipboard

[Docs] Manpage poc

Open luarss opened this issue 1 year ago • 25 comments

@precisionmoon

TODO

  • final docs check

Suggestions

  • add -no-pager
  • ;#undocumented for checker off.

luarss avatar Jan 16 '24 18:01 luarss

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Jan 16 '24 18:01 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Jan 16 '24 18:01 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Jan 16 '24 19:01 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Jan 16 '24 19:01 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Jan 16 '24 19:01 github-actions[bot]

Cho, answers to the following:

  • are files under docs/md directory symlinks? No, currently they are actual files. We will gradually migrate these to the actual READMEs since the format is still not fixed yet
  • Can we make the file suffix consistent? Can everything be *.md suffix like openroad.md instead of .txt? Yes, will put that on our todo.
  • where are contents of docs/md/man3? Errors/info/warnings yet to be populated
  • where will "cat" version of man pages be populated? Does Util.tcl man command know where to find the "cat" pages? Yes they will find the files in docs/manpages/cat

luarss avatar Jan 17 '24 03:01 luarss

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Feb 06 '24 15:02 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Feb 06 '24 16:02 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Feb 06 '24 18:02 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Feb 06 '24 18:02 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Feb 06 '24 18:02 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Feb 07 '24 12:02 github-actions[bot]

@precisionmoon Ready for review.

For some reason it passes the ibex_sky130hd CI in pr-head but not pr-merge, so I am not sure if something is wrong with my branch.

luarss avatar Feb 07 '24 14:02 luarss

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Feb 08 '24 18:02 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Feb 08 '24 18:02 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Feb 13 '24 16:02 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Feb 13 '24 18:02 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Feb 13 '24 18:02 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Feb 14 '24 01:02 github-actions[bot]

@maliberty, can Jack's PR be merged?

precisionmoon avatar Feb 20 '24 21:02 precisionmoon

There are a bunch of conflicts to resolve in the .tcl files

maliberty avatar Feb 20 '24 22:02 maliberty

Jack,

Please do the following and resolve merge conflicts.

  1. git fetch origin
  2. git merge origin/master
  3. manually merge conflicts

Thanks.

Cho

On Tue, Feb 20, 2024 at 2:01 PM Matt Liberty @.***> wrote:

There are a bunch of conflicts to resolve in the .tcl files

— Reply to this email directly, view it on GitHub https://github.com/The-OpenROAD-Project/OpenROAD/pull/4543#issuecomment-1955191909, or unsubscribe https://github.com/notifications/unsubscribe-auth/BBVEJRV24ANM5ODHYJBEVH3YUUMLRAVCNFSM6AAAAABB5ICMDSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNJVGE4TCOJQHE . You are receiving this because you were mentioned.Message ID: @.***>

precisionmoon avatar Feb 20 '24 22:02 precisionmoon

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Feb 22 '24 17:02 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Feb 22 '24 18:02 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Feb 22 '24 18:02 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Feb 24 '24 17:02 github-actions[bot]

@maliberty I have added new changes to local tests above. Would love your feedback. Thanks!

luarss avatar Feb 29 '24 22:02 luarss

You have a merge conflict to address in src/mpl2/src/mpl.tcl

maliberty avatar Mar 05 '24 00:03 maliberty

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Mar 05 '24 01:03 github-actions[bot]

clang-tidy review says "All clean, LGTM! :+1:"

github-actions[bot] avatar Mar 05 '24 02:03 github-actions[bot]