blender/tools/utils_ide/qtcreator
Sergey Sharybin 03806d0b67 Re-design of submodules used in blender.git
This commit implements described in the #104573.

The goal is to fix the confusion of the submodule hashes change, which are not
ideal for any of the supported git-module configuration (they are either always
visible causing confusion, or silently staged and committed, also causing
confusion).

This commit replaces submodules with a checkout of addons and addons_contrib,
covered by the .gitignore, and locale and developer tools are moved to the
main repository.

This also changes the paths:
- /release/scripts are moved to the /scripts
- /source/tools are moved to the /tools
- /release/datafiles/locale is moved to /locale

This is done to avoid conflicts when using bisect, and also allow buildbot to
automatically "recover" wgen building older or newer branches/patches.

Running `make update` will initialize the local checkout to the changed
repository configuration.

Another aspect of the change is that the make update will support Github style
of remote organization (origin remote pointing to thy fork, upstream remote
pointing to the upstream blender/blender.git).

Pull Request #104755
2023-02-21 16:39:58 +01:00
..
externaltools Re-design of submodules used in blender.git 2023-02-21 16:39:58 +01:00
readme.rst Re-design of submodules used in blender.git 2023-02-21 16:39:58 +01:00

This repository contains utilities to perform various editing operations as well as some utilities to integrate
Uncrustify and Meld.


This is for my own personal use, but I have tried to make the tools generic (where possible) and useful to others.


Installing
==========

All the scripts install to QtCreators ``externaltools`` path:

eg:
``~/.config/QtProject/qtcreator/externaltools/``

Currently QtCreator has no way to reference commands relative to this directory so the ``externaltools`` dir **must**
be added to the systems ``PATH``.


Tools
=====

Here are a list of the tools with some details on how they work.


Assembler Preview
-----------------

``External Tools -> Compiler -> Assembler Preview``

This tool generates the assembly for the current open document,
saving it to a file in the same path with an ".asm" extension.

This can be handy for checking if the compiler is really optimizing out code as expected.

Or if some change really doesn't change any functionality.

The way it works is to get a list of the build commands that would run, and get those commands for the current file.

Then this command runs, swapping out object creation args for arguments that create the assembly.

.. note:: It would be nice to open this file, but currently this isn't supported. It's just created along side the source.

.. note:: Currently only GCC is supported.