.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "YCM-FAQ" "7" "Nov 05, 2023" "0.13." "YCM"
.SH NAME
ycm-faq \- YCM FAQ
.SH YCM FAQ
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
What does YCM means?
.TP
.B \fBA\fP
Originally it was “\fI\%YARP\fP CMake
Modules”, but the name this makes no longer sense, therefore
it is now just YCM. See also \fI\%YCM issue #40\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
How do I report a bug or request a feature?
.TP
.B \fBA\fP
Open a new bug on our \fI\%issue tracker\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
CMake module XXX has a bug/missing feature in CMake version
\fIN\fP and has been fixed/updated in CMake version \fIN+1\fP\&. Can you
import the updated module in YCM and make it available for
CMake \fIN\fP and older?
.TP
.B \fBA\fP
Yes, just open an issue or a merge request, but see the next
question.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
Can you actually use any module from a newer version of CMake?
.TP
.B \fBA\fP
No, modules using features that have been added in CMake
source code cannot be imported directly.
Nonetheless it is possible to supply a patched version of the
module that does not use these features.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
Why support CMake 3.12?
.TP
.B \fBA\fP
YCM was historically written to support \fI\%YARP\fP, therefore the
supported CMake versions are the same supported by \fI\%YARP\fP\&.
See \fI\%YARP Supported Distributions\fP for details.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
Can a YCM superbuild build the \fBPackageName\fP package?
.TP
.B \fBA\fP
Probably it can, you will have to supply a
\fBBuildPackageName.cmake\fP file with the instructions about how
it should be built. You can use \fI\%YCMEPHelper\fP or
\fI\%ExternalProject\fP to simplify the process. If
\fBPackageName\fP is not written using CMake, writing such file
might be a bit more difficult, but it can be done.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
Why using \fI\%ExternalProject\fP instead of using
git submodules, git externals, svn externals, or similar?
.TP
.B \fBA\fP
\fI\%ExternalProject\fP supports Git, Subversion, CVS,
Mercurial, and zipped files, not just git. Also integrating
these tools in a CMake build would require some work anyway,
and would make is slower to create a new superbuild project,
just writing a \fBCMakeLists.txt\fP file is a lot easier.
Also git submodules and git externals in an environment where users
do not receive a proper training, introduce more issues than the
ones they solve.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
The \fI\%IncludeUrl\fP module is just \fBevil\fP\&. It could be
used to inject any code on your system.
.TP
.B \fBA\fP
That’s why you can check the hash of the file included and why
you don’t usually build it as root. If you don’t trust the
source you shouldn’t even build the software without checking
the source code, but that rarely happens. Also the
\fI\%IncludeUrl\fP module is used only for the bootstrap
phase, if YCM is installed on your system, the bootstrap phase
will just be skipped. In your code you can just use
\fBfind_package(YCM REQUIRED)\fP and avoid using it.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
Why is the bootstrap phases checking the hashes of the files
included in my project?
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBA\fP
The bootstrap phase also checks that the files used for the
bootstrap phase itself are updated, and warns the developer
in order to make it easier to keep all the projects
synchronized.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
How is YCM different from \fI\%ECM\fP (KDE extra cmake modules)?
.TP
.B \fBA\fP
Conceptually it’s not much different except for support for
older CMake releases and bootstrap phase. For some time YCM
was also able to bootstrap ECM as well, in order to be able to
use ECM modules without installing them. This functionality
has been removed for now, but might come back some time in the
future.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
How is YCM different from \fI\%catkin\fP?
.TP
.B \fBA\fP
\fI\%catkin\fP and  are very specific for working with \fI\%ROS\fP and
add extra dependencies to your project (i.e. python).
Also \fI\%catkin\fP does a lot of magic, and we didn’t like it when
we tried it.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
How is YCM different from \fI\%rosbuild\fP ?
.TP
.B \fBA\fP
\fI\%rosbuild\fP is deprecated, you should eventually consider
using \fI\%catkin\fP instead.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
How is YCM different from \fI\%qibuild\fP?
.TP
.B \fBA\fP
\fI\%qibuild\fP requires python. Also TODO
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
How is YCM different from \fI\%Buildyard\fP
.TP
.B \fBA\fP
We were not aware of \fI\%Buildyard\fP when we started writing YCM.
Some of the goals of the projects are very similar, but TODO
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
How is YCM different from \fI\%biicode\fP
.TP
.B \fBA\fP
TODO.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
How is YCM different from \fI\%hunter\fP
.TP
.B \fBA\fP
TODO.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
How is YCM different from XXX
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBA\fP
Probably we don’t know about it.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBQ\fP
I don’t get it, I don’t like YCM, I hate you.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBA\fP
Sorry.
.UNINDENT
.UNINDENT
.SH COPYRIGHT
Copyright 2012-2021 Istituto Italiano di Tecnologia (IIT)
.\" Generated by docutils manpage writer.
.