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.

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

Build cspec documentation for Decompiler #1856

Closed
rchildre3 opened this issue May 13, 2020 · 5 comments
Closed

Build cspec documentation for Decompiler #1856

rchildre3 opened this issue May 13, 2020 · 5 comments

Comments

@rchildre3
Copy link

Describe the bug
cspec documentation files exist in Ghidra/Features/Decompiler/src/main/doc/ yet are not built alongside its siblings in the build.gradle script for the Decompiler

Expected behavior
The docs are built. Looks like they may have just been left out of the buildDecompilerDocumentationPdfs and buildDecompilerDocumentationHtml tasks

Environment (please complete the following information):

  • OS: Windows
  • Java Version: 11.0.7
  • Ghidra Version: 9.1.2

Additional context
#472

@bevanweiss
Copy link

Any chance the pspec docs could be added also? (or am I being dense and they are there already?)

@starfleetcadet75
Copy link

Unfortunately there are no pspec docs in Ghidra/Features/Decompiler/src/main/doc/ in the first place. The cspec ones were already there, they just weren't being compiled.

There is the Relax spec at Ghidra/Framework/SoftwareModeling/data/languages/processor_spec.rxg for reference, but it doesn't describe the fields.

@bevanweiss
Copy link

So the way to get the documentation would be to reverse engineer the Java sourcecode behind the main Ghidra program? :(

@rchildre3
Copy link
Author

So the way to get the documentation would be to reverse engineer the Java sourcecode behind the main Ghidra program? :(

I wouldn't say reverse engineer, more so just reading the source code (looks like it is in C++: Ghidra/Features/Decompiler/src/decompile/cpp/architecture.cc). It is unfortunate that there aren't docs, but with the spec @starfleetcadet75 pointed out and the various *.pspec files in the source code, You should be able to get a decent overview of what goes in the file.

@SamB
Copy link
Contributor

SamB commented Jul 28, 2021

@rchildre3 did you close this by mistake? The original proposal was just to include the cspec docs along with the other decompiler stuff, and I have a PR that does only slightly more than that -- the only extra things I remember doing were remove hardcoded distro-specific paths to the docbook XSLT stylesheets, and add a missing trailing slash to a path somewhere.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants