bugLiberty Eiffel - Bugs: bug #65306, eiffeldoc with ACE file doesn't...

 
 

bug #65306: eiffeldoc with ACE file doesn't accept presentation options

Submitter:  Jakub Pavlík <igneus>
Submitted:  Tue 13 Feb 2024 04:57:39 PM UTC
   
 
Category:  Liberty tools Severity:  3 - Normal
Priority:  * 5 - Normal Status:  None
Assigned to:  None Open/Closed:  Open
Release:  None Fixed Release:  None
Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Wed 21 Feb 2024 07:21:05 PM UTC, comment #4: 

Given a.out containing compiled binary of the example class from https://github.com/LibertyEiffel/Liberty/pull/183 :

== Option order is important

$ ./a.out -f John -l Doe -e "Book title" 2000
-- is invalid because of the -e, but why?

$ ./a.out -f John -e -l Doe "Book title" 2000
-- crashes

$ ./a.out -e -f John -l Doe "Book title" 2000
-- seems to be the only accepted order to pass the -e option

== Short option grouping

$ ./a.out -ve -f John -l Doe "Book title" 2000
-- -v is processed (program displays verbosity level), -e ignored (program doesn't print the "ed." shortcut)

$ ./a.out -ev -f John -l Doe "Book title" 2000
-- -e is processed, -v ignored

With a different program I have also experienced cases of a valid optional option being treated as a value for a positional argument, I will try to isolate that case later.

Jakub Pavlík <igneus>
Wed 21 Feb 2024 06:58:24 PM UTC, comment #3: 

comment #2:

> Letting all Liberty developers experience the shortcomings while using the tools may be useful as a way to accelerate the cluster's process of maturation, though :)


I wasn't aware of those shortcomings. Can you make some example?

Ideally we could turn those into tests for the cli cluster.

Paolo Redaelli <Tybor>
Group administrator
Wed 21 Feb 2024 06:22:42 PM UTC, comment #2: 


> I think that it may be useful to start "eating our own dog-food" and progressively make short, eiffeldoc and all the tool using that cluster, as I found it to be quite comfortable.


It's quite pleasant to use when coding, but the actual parsing sometimes works in unexpected ways and rejects option combinations which would be fine by the most usual Linux standards.
Letting all Liberty developers experience the shortcomings while using the tools may be useful as a way to accelerate the cluster's process of maturation, though :)

Jakub Pavlík <igneus>
Sat 17 Feb 2024 11:13:46 PM UTC, comment #1: 

All tools have been written before Cyril created the command line argument cluster, i.e. src/lib/cli

I think that it may be useful to start "eating our own dog-food" and progressively make short, eiffeldoc and all the tool using that cluster, as I found it to be quite comfortable.

Regrettably there's no tutorial about it.

Paolo Redaelli <Tybor>
Group administrator
Tue 13 Feb 2024 04:57:39 PM UTC, original submission:  

When executed with an ACE file as argument, eiffeldoc rejects any command line options except of -version and -verbose, making it impossible to provide -css, -js, -title and other presentation-related options. It doesn't seem to be possible to set them in the ACE file.

Some way to specify them should definitely be provided. I don't have a strong opinion if the right way to do so is allowing the command line options, adding new settings to the ACE file, or both.

(Related issue: Regarding -css and -js it would be preferable to include the /resources/eiffeldoc/eiffeldoc.(js|css) ones unless specified otherwise, because the unformatted HTML, as is currently produced by default, is ugly and useless. Default settings should provide reasonable results.)

Jakub Pavlík <igneus>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by Tybor (Posted a comment)
  • -email is unavailable- added by igneus (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only logged-in users can vote.

     

    No changes have been made to this item

    Back to the top

    Powered by Savane 3.13-6ae7.
    Corresponding source code