QProcess documentation is inconsistent

koahnig · wrote on 25 Mar 2015, 16:58

The documentation of QProcess is insonsistent. I was searching for setting the environment in the method list at top and could not find anything. With Chrome search I could find a reference on page later. However, it is not marked as a proper reference.

systemEnvironment can be found under static methods. There is a reference to setEnvironment, but it links to an obsolete page

Chris Kawa · 25 Mar 2015, 17:59

The docs are ok. setEnvironment is obsolete so it's not listed in the main doc page. The recommended method now is setProcessEnvironment and it is listed at the top as usual.

koahnig · wrote on 25 Mar 2015, 17:59

@Chris-Kawa
Sorry to disagree
Certain processes need special environment settings in order to operate. You can set environment variables for your process by calling setEnvironment(). To set a working directory, call setWorkingDirectory(). By default, processes are run in the current working directory of the calling process.
That is one section which still looks like that setEnvironment can be called (see on QProcess doc in section Communicating via channels 4th paragraph). Also later it is not clear. Only when using the link as mentioned in my initial post, you can see only indirectly through the page link shown by your browser. In the text itself it seems to be the original text. You need to scroll up to actually read that all those methods are obsolete.

Chris Kawa · wrote on 25 Mar 2015, 18:13

Ah, sorry. Yes, now I see it. Documentation bugs are reported just as any other via bug tracker.

koahnig · wrote on 25 Mar 2015, 18:48

Filed a bug report on JIRA

Chris Kawa · wrote on 25 Mar 2015, 18:52

I see you filed it as a website bug. Documentation is part of the library and should be filed against the Qt library version you spotted it in, not the website, I think.

SGaist · wrote on 25 Mar 2015, 23:41

Hi,

IIRC, the bug can be moved over by the admins so no need to duplicate it.

tekojo · wrote on 26 Mar 2015, 06:49

Moved to the "Qt" project and documentation in Bugtracker.
https://bugreports.qt.io/browse/QTBUG-45235

And thanks @SGaist for providing the patch, should I give the bug over to you actually?

SGaist · wrote on 26 Mar 2015, 07:57

@tekojo You're welcome ! And yes :)

koahnig · 26 Mar 2015, 08:57

Thanks guys for taking care

Where to file a bug report is not obvious when you are not on it on an everydays basis.

BTW I saw a couple of bug reports on my list which are no longer relevant with the move of the website. Those bugs are :
https://bugreports.qt.io/browse/QTWEBSITE-337
https://bugreports.qt.io/browse/QTWEBSITE-447
https://bugreports.qt.io/browse/QTWEBSITE-452
https://bugreports.qt.io/browse/QTWEBSITE-455
https://bugreports.qt.io/browse/QTWEBSITE-477

Since I am not able to close them, I left a message/comment for each report there as well.

tekojo · wrote on 26 Mar 2015, 08:57

@koahnig thanks, closed those as requested.