[Swig-devel] [ swig-Bugs-2528959 ] -outcurrentdir not documented

[SourceForge.net <no...@so...>]

Bugs item #2528959, was opened at 2009-01-22 12:13
Message generated for change (Comment added) made by mikld
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=101645&aid=2528959&group_id=1645

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: documentation
Group: None
Status: Closed
Resolution: Fixed
Priority: 5
Private: No
Submitted By: Michael Dickens (mikld)
Assigned to: William Fulton (wsfulton)
Summary: -outcurrentdir not documented

Initial Comment:
With the release of 1.3.37, a MAJOR change occurred in where output files are written which is not backwards compatible with previous versions of SWIG.  This change does not seem to be documented yet on either the SWIG documentation provided in the tarball or on the main WWW area. The change is:

1.3.36:

    -outdir <dir>   - Set language specific files output directory <dir>

1.3.37:

    -outcurrentdir  - Set default output dir to current dir instead of input file's path
    -outdir <dir>   - Set language specific files output directory to <dir>

This seems to imply a new "split" in where output files are written:

* By default in 1.3.36, all files are written to the output directory (the one from which the 'swig' command was called).

* By default in 1.3.37, generated C++ files are written to the output directory, while generated non-C++ files are written to the input directory (the one containing the input .i file).  To get the output directory to behave as in 1.3.36 or earlier releases, one now needs to specify "-outcurrentdir" (or "-outdir .", which should be backwards compatible to about version 1.3.20).

I have no issue with this change, if it is what is intended and/or desired.  But the documentation needs to be updated to reflect this important, not backwards compatible change, and IMHO, it should be highlighted somewhere prominent ("Recent Changes" maybe) because of the non-backwards compatibility (not just an added feature, but a change to current feature's behavior).

Thanks for listening. - MLD

----------------------------------------------------------------------

>Comment By: Michael Dickens (mikld)
Date: 2009-01-29 16:28

Message:
Thanks for all of the changes and info; I always run the SWIG command in
the same directory as the -o goes into, so I hadn't thought about the
output directory in that way.  I look forward to all of these changes in
.38.

----------------------------------------------------------------------

Comment By: William Fulton (wsfulton)
Date: 2009-01-29 16:11

Message:
A regression might occur when specifying -o which has been rectified and
will go into 1.3.38. More documentation on -outcurrentdir added too. BTW,
the default output directory is not the directory from where SWIG is run,
it is the directory of the input file and if the -o is used, then it is the
directory given in -o. 

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=101645&aid=2528959&group_id=1645