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

Is there any documentation for pspec and cspec files? #472

Closed
quantumbracket opened this issue Apr 20, 2019 · 6 comments
Closed

Is there any documentation for pspec and cspec files? #472

quantumbracket opened this issue Apr 20, 2019 · 6 comments
Labels
Type: Question Further information is requested

Comments

@quantumbracket
Copy link

No description provided.

@quantumbracket quantumbracket added the Type: Question Further information is requested label Apr 20, 2019
@Escapingbug
Copy link
Contributor

There are some refs at here. But I'm also kind of feeling confused here, as many fields are not documented..

@bdemick
Copy link

bdemick commented Apr 22, 2019

Completely agree. I'd love to see some more extensive documentation on all of the processor-related files. The SLEIGH docs are great, but could use some more practical examples in-line vs. having to stare at the *sinc/*slaspec files for other architectures, and parse through a very large source tree to get the answers. This works, and does help with understanding the overall structure of the project, but would be much quicker if there were just a tad bit more documentation and perhaps a step-by-step overview that covers an outline for the derivation of one of the simpler existing architectures.

@rkfg
Copy link

rkfg commented Apr 23, 2019

The docs are here, you'll need to xsltproc them to get a bunch of HTML files or a pdf. I had to install docbook-xsl to get the needed files for the conversion and I also changed the path in cspec_html.xsl. Then I ran xsltproc cspec_html.xsl cspec.xml.

@mumbel
Copy link
Contributor

mumbel commented Apr 23, 2019

Thanks @rkfg
Not sure if i was just missing a package or not, but on Debian I had to modify cspec_html.xsl. Not sure if this change is correct, but it did produce html.

-<xsl:import href="/usr/share/sgml/docbook/xsl-stylesheets/html/chunk.xsl"/>
+<xsl:import href="/usr/share/xml/docbook/stylesheet/docbook-xsl/html/chunk.xsl"/>

@rkfg
Copy link

rkfg commented Apr 24, 2019

Yep, I did the same (and mentioned it, though it was pretty vague I admit).

@bdemick
Copy link

bdemick commented Apr 24, 2019

Double thanks @rkfg !

On a Mac I had to just install docbook-xsl via brew and fix up the import path:

-<xsl:import href="/usr/share/sgml/docbook/xsl-stylesheets/html/chunk.xsl"/>
+<xsl:import href="/usr/local/Cellar/docbook-xsl/1.79.1/docbook-xsl/html/chunk.xsl"/>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Question Further information is requested
Projects
None yet
Development

No branches or pull requests

6 participants