Qt Creator documentation FAQ - minor modification proposal



  • Hi, I'd just like to propose a minor change in the FAQ section of Qt Creator documentation: instead of a generic path for Windows systems, you could use environment variables (so that users can copy & paste the paths without worrying if they installed Windows on the F:\ drive or what is their username directory).

    "Qt Creator FAQ":http://qt-project.org/doc/qtcreator/creator-faq.html, question 1 (current answer, last two paragraphs)
    @
    On Windows XP, the files are located in <drive>:\Documents and Settings<username>\Application Data\QtProject and <drive>:\Documents and Settings<username>\Local Settings\Application Data\QtProject.

    On Windows Vista and Windows 7, the files are located in <drive>:\Users<username>\AppData\Roaming\QtProject and <drive>:\Users<username>\AppData\Local\QtProject.
    @

    "Qt Creator FAQ":http://qt-project.org/doc/qtcreator/creator-faq.html, question 1 (proposed new answer, last two paragraphs)
    @
    On Windows XP, the files are located in %SystemDrive%\Documents and Settings%username%\Application Data\QtProject and %SystemDrive%\Documents and Settings%username%\Local Settings\Application Data\QtProject.

    On Windows Vista and Windows 7, the files are located in %SystemDrive%\Users%username%\AppData\Roaming\QtProject and %SystemDrive%\Users%username%\AppData\Local\QtProject.
    @

    As you can see the only difference is in the 2 paths for each Windows family, which now use environment variables (à la Windows of course).

    I don't know if this (Forums -> Tools) is a good place to propose this little silly change on Qt Creator Documentation FAQ, but I didn't find any other suitable places.

    Let me know if you can make this little change, or if I should post this request elsewhere.

    Cheers

    P.S.: For a quite complete list of Windows environment variables:
    http://en.wikipedia.org/wiki/Environment_variable#Microsoft_Windows

    P.P.S.: I had to put the text paragraphs to modify as "code" because otherwise the Windows style environment variables would fail to appear, at least %SystemDrive% (which you can now see without percentual signs before and after, but I just wrote them in the source of this message - maybe a problem with your site, with the forum manager code or similar?)


  • Lifetime Qt Champion

    Hi and welcome to devnet,

    You can open a request on the "bug report system":http://bugreports.qt-project.org so the Qt Creator developers/maintainers will see it.

    If you feel brave enough you can even submit a patch yourself (settings things up is not that hard), all contributions even small are welcome :)



  • Hi,

    I'm sorry but this is quite not the case (it's not a bug of any sort), because my question refers to the online documentation of Qt Creator, in particular at its FAQ section:
    http://qt-project.org/doc/qtcreator/creator-faq.html

    Thanks for the welcome anyway, and if you have any other idea about where to ask for this little modification, please let me know.

    (if you read my previous P.P.S. final paragraph you can see why I had to post the code blocks, but IT'S NOT CODE, just text to be modified)


  • Lifetime Qt Champion

    On the contrary :)

    AFAIK, this is the online version of the FAQ from Qt Creator. So it's generated from Qt Creator's documentation, thus it can be considered as a documentation bug or maybe a feature request.

    I've read your P.P.S. and understood your point. The bug report system is not only for code related bugs, documentation is a core part of Qt and improving it is also very welcome. I should have talk about it right away, my bad.



  • Oh, I see... ok then, I'll post the little request there ("bug report system":http://bugreports.qt-project.org/), thank you for the clarification.


  • Lifetime Qt Champion

    Don't forget to post a link to the report in case other forum members are interested :)



  • Yes, you're right!

    Link to the bug report system thread:
    https://bugreports.qt-project.org/browse/QTCREATORBUG-12283

    (you can find the following linked in the previous thread comments, but I'll also explicitely link the "code review work in progres":https://codereview.qt-project.org/#change,85995)


  • Lifetime Qt Champion

    Nice, thanks :)


Log in to reply
 

Looks like your connection to Qt Forum was lost, please wait while we try to reconnect.