Skip to content

Documentation: describe how to get compiler version#74

Merged
loomis merged 4 commits intoquattor:masterfrom
jouvin:documentation
Oct 22, 2014
Merged

Documentation: describe how to get compiler version#74
loomis merged 4 commits intoquattor:masterfrom
jouvin:documentation

Conversation

@jouvin
Copy link
Contributor

@jouvin jouvin commented Sep 13, 2014

Fixes #71.

Also improves documentation on how to use global variables in bind paths.

@jouvin jouvin force-pushed the documentation branch 2 times, most recently from 6ada7f5 to 0d0511b Compare September 13, 2014 21:41
@jouvin
Copy link
Contributor Author

jouvin commented Sep 13, 2014

Documentation complete but DO NOT MERGE

Need help with DocBook tables from an expert! I followed instruction I found to have columns of different size but when I add the colspec lines, the cells are empty (despite having the expecting size!). Anything wrong? Or something to do with the stylesheet? Similar colspec is used in the main document and seems to work...

@jouvin
Copy link
Contributor Author

jouvin commented Sep 14, 2014

I did a test: I added the table to the main document and it works just fine. I also added the Typographical conventions table from the main document in the appendix where it doesn't work...

@jouvin
Copy link
Contributor Author

jouvin commented Sep 14, 2014

I progressed a little bit in my testing... My table with colspec (or any similar table in the document) is rendered as expected if it is placed in the main document but has its contents empty it is placed in an appendix (included in the main document with xi:include). The pb affects all output formats (checked pdf and html). I found no error reported in the maven output that could be related to this...

@jouvin
Copy link
Contributor Author

jouvin commented Sep 14, 2014

I added to the commits the test I did... TO BE REMOVED before merging...

jouvin added a commit to jouvin/pan that referenced this pull request Sep 14, 2014
@jouvin
Copy link
Contributor Author

jouvin commented Sep 14, 2014

I updated the commit containing the tests with a test book, test.xml that includes appendix appendix_test.xml. Contents is very minimal do demonstrate the problem described above. I did a lot of Googling but was not able to find anything relevant...

@loomis
Copy link

loomis commented Sep 14, 2014

I'd suggest the following changes:

  • The new ant task should be listed and documented in the ant section for running the compiler.
  • The man page entries should be updated with the new attributes.
  • The "getting the version" section really is only the table, so remove the separate section and just reference the table from the appropriate section.

@jouvin
Copy link
Contributor Author

jouvin commented Sep 14, 2014

The simpler form doesn't work for me if used with jar-with-dependencies:

lhcb3/jouvin % java -jar panc/target/panc-10.2-SNAPSHOT.jar
10.2-SNAPSHOT

but:

lhcb3/jouvin % java -jar panc/target/panc-10.2-SNAPSHOT-jar-with-dependencies.jar
no main manifest attribute, in panc/target/panc-10.2-SNAPSHOT-jar-with-dependencies.jar

May be this missing main manifest attribute can be fixed...

jouvin added a commit to jouvin/pan that referenced this pull request Sep 14, 2014
@jouvin
Copy link
Contributor Author

jouvin commented Sep 14, 2014

Updated commits address the first 2 remarks in #74 (comment). For the third one, I am not sure to understand your suggestion: what is the section you'd recommend as appropriate? I found none where you may look spontaneously if you would like to know the compiler version... thus the reason for added one that will appear in the TOC.
BTW, the table rendering is still broken... no progress on this on my side.

@jouvin
Copy link
Contributor Author

jouvin commented Sep 14, 2014

Main manifest fixed in jar-with-dependencies and documentation updated as suggested with java -jar.
Table rendering issue worked around by disabling colspec lines as standard layout is now fine with the shorter command line for Java invocation.
Still the last remark in #74 (comment) to discuss (see previous comment).

(previously defining colwidth was triggering an exception)
@loomis
Copy link

loomis commented Sep 15, 2014

"How to get the compiler version" doesn't really warrant a separate section, especially given that the only content is a table and a sentence saying "look at the table". The table title will show up in the list of tables, so that should be sufficient for people to find the necessary information.

@jouvin
Copy link
Contributor Author

jouvin commented Sep 16, 2014

Back to the discussion on whether it should be a section or not, I understand your point but I am not sure there is a good section where to put this table. This is the other reason (with increased exposure) why I created this section.
BTW, I fixed the pom file to get the PDF bookmarks for the entries in the TOC. And it happens that tables and figures are not bookmarked. I have no clue how to change it. In the meantime, this reduces the exposure to tables and figures...

@loomis loomis added this to the 10.2 milestone Sep 30, 2014
@jouvin
Copy link
Contributor Author

jouvin commented Oct 22, 2014

Commit on variables in bind paths has nothing to do with the original merge request but is a slight improvement to the doc... I piggy back this PR! bind statement usage is covered both in section 3 and chapter 7. It would be good to better cross-reference both but I don't know how to reference a chapter or section from the text...

loomis pushed a commit that referenced this pull request Oct 22, 2014
Documentation: describe how to get compiler version
@loomis loomis merged commit 332f00d into quattor:master Oct 22, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

extract pan version from commandline and jar

2 participants