search

adobe / hyde

A front-end to Jekyll that parses C++ sources to produce and enforce out-of-line documentation
http://opensource.adobe.com/hyde/
MIT License
323 stars 41 forks source link

Command Line Options - relative paths inconsistent #37

Open sean-parent opened 5 years ago

sean-parent commented 5 years ago

Describe the bug The path for -hyde-yaml-dir and -hyde-src-root is relative to the directory containing the file being processed. i.e. 

hyde ./include/psutil/safe_cast.hpp -hyde-src-root=../../include -hyde-yaml-dir=../../docs/include

Here the path ../../include is relative to ./include/psutil/ and not the current working directory.

fosterbrereton commented 5 years ago

Am I understanding correctly that you'd like the relative paths to be from the current working directory? That means you must navigate to a specific path before running the tool in order for it to function. I based the relative paths off the source file being processed because then the tool can be run regardless of the current working directory, which seemed the more flexible option.

sean-parent commented 5 years ago

Let's say I have: include/library/file.hpp include/library/sub/other.hpp

I would have to have two separate roots for each of those. That is a bit of a pain. Normally a path specified on the command line is relative to the current working directory, and a path in a file (like a config file, header file, html file, etc.) is relative to that file. Having the path be relative to some other file is weird and confusing.