Method

IdeVcsis_ignored

Declaration

gboolean
ide_vcs_is_ignored (
  IdeVcs* self,
  GFile* file,
  GError** error
)

Description

This function will check if file is considered an “ignored file” by the underlying Version Control System.

For convenience, this function will return TRUE if file is NULL.

If self is NULL, only static checks against known ignored files will be performed (such as .git, .flatpak-builder, etc).

Parameters

file

Type: GFile

A GFile.

The argument can be NULL.

The data is owned by the caller of the method.

error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.

If the return location is not NULL, then you must initialize it to a NULL GError*.

The argument will be left initialized to NULL by the method if there are no errors.

In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: gboolean

TRUE if the path should be ignored.

Thread safety: This function is safe to call from a thread as IdeVcs implementations are required to ensure this function is thread-safe.