Skip to content

Clang format check not properly working for code behind compiler directives #1537

Description

@SaschaWillems

I've been battling Clang format for a larger PR and it seems that the Clang format check is not properly working for code that is guarded by a compiler define.

E.g. this code:

#ifdef SOMETHING
#else
	VkRenderPassBeginInfo render_pass_begin_info    = vkb::initializers::render_pass_begin_info();
	render_pass_begin_info.renderPass               = render_pass;
	render_pass_begin_info.renderArea.offset.x      = 0;
	render_pass_begin_info.renderArea.offset.y      = 0;
	render_pass_begin_info.renderArea.extent.width  = width;
	render_pass_begin_info.renderArea.extent.height = height;
	render_pass_begin_info.clearValueCount          = 5;
	render_pass_begin_info.pClearValues             = clear_values;
	render_pass_begin_info.framebuffer              = framebuffers[current_image_index];
#endif

Triggers a Clang format CI failrure, even though the formatting was chnaged like that Clang format itself. And this looks exactly like our formatting guidelines

Reverting this by hand to look like this:

#ifdef SOMETHING
#else
	VkRenderPassBeginInfo render_pass_begin_info = vkb::initializers::render_pass_begin_info();
	render_pass_begin_info.renderPass = render_pass;
	render_pass_begin_info.renderArea.offset.x = 0;
	render_pass_begin_info.renderArea.offset.y = 0;
	render_pass_begin_info.renderArea.extent.width = width;
	render_pass_begin_info.renderArea.extent.height = height;
	render_pass_begin_info.clearValueCount = 5;
	render_pass_begin_info.pClearValues = clear_values;
	render_pass_begin_info.framebuffer = framebuffers[current_image_index];

Fixes CI.

IMO that's wrong and needs to be fixed, otherwise every time I do a local Clang format for files changed I need to wait for CI to fail, decipher a cryptic message and manually fix stuff again.

Metadata

Metadata

Assignees

No one assigned

    Labels

    buildThis is relevant to the build system

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions