Clang-Format: Ensure new line at the end of files #118031

Sergey Sharybin · 2024-02-09T11:03:33+01:00

Sergey Sharybin commented

2024-02-09 11:03:33 +01:00

Not all editors are configured by default to ensure new line at the
end of file.

To reduce noise and make code more uniform ensure the new lines are
ensured by the clang-format.

Not all editors are configured by default to ensure new line at the end of file. To reduce noise and make code more uniform ensure the new lines are ensured by the clang-format.

👍 4

Sergey Sharybin added 1 commit 2024-02-09 11:03:37 +01:00

e186ecd1ef Clang-Format: Ensure new line at the end of files

Not all editors are configured by default to ensure new line at the
end of file.

To reduce noise and make code more uniform ensure the new lines are
ensured by the clang-format.

Bastien Montagne approved these changes 2024-02-09 11:08:36 +01:00

Bastien Montagne left a comment

+1, always annoyed when this is missing...

Sebastian Parborg commented

2024-02-09 11:18:34 +01:00

+1, always annoyed when this is missing...

Ditto

> +1, always annoyed when this is missing... Ditto

Campbell Barton approved these changes 2024-02-09 11:38:17 +01:00

Sergey Sharybin merged commit c6b6714555 into main

2024-02-09 14:32:19 +01:00

Sergey Sharybin referenced this issue from a commit

2024-02-09 14:32:20 +01:00

Clang-Format: Ensure new line at the end of files

Sergey Sharybin deleted branch clang_format_newline

2024-02-09 14:32:22 +01:00

Brecht Van Lommel commented

2024-02-15 23:03:16 +01:00

I think this should be committed to blender-v4.1-release as well, it is causing problems when merging changes into main.

For example:
blender/blender@86522d9ab1
blender/blender@0801fcd6b3

I think this should be committed to `blender-v4.1-release` as well, it is causing problems when merging changes into main. For example: blender/blender@86522d9ab1f2bdfc692d87eeec5def81885a70eb blender/blender@0801fcd6b32fc16740036558d2dab30f228e77d7

Brecht Van Lommel commented

2024-02-16 00:13:40 +01:00

There seems to be a bug with this feature where it does the opposite, removing the new line.
https://github.com/llvm/llvm-project/issues/63150

There seems to be a bug with this feature where it does the opposite, removing the new line. https://github.com/llvm/llvm-project/issues/63150

Sergey Sharybin commented

2024-02-16 12:18:15 +01:00

The report you've linked is about removing trailing new lines when you have multiple at the end of file. This can become more explicit configuration to ensure consistency by (so that we don't rely on default, which might change):

# Ensure single new line at the end of source files.
InsertNewlineAtEOF: True
KeepEmptyLinesAtEOF: False

The commit from Sebastian you've linked has 2 trailing new lines at the end of the sequencer_clipboard.cc file, which then got stripped down to a single new line by Bastien's cleanup.

We looked into it with Sebastian, and it seems that the clang_format.py script does not work well when the new line is inserted by clang-format, leading to extra new line adde to the vim's buffer. Using the language-server integration of clang-format does not experience this issue. I also do not experience such issue with neither make format nor VS Code with its official clang-format extension.

The proposal is:

Add KeepEmptyLinesAtEOF: False to the .clang-format
Commit the changes to 4.1
People using clang_format.py Vim integration need to ensure the integration properly handles new lines inserted by a formatter

The report you've linked is about removing trailing new lines when you have multiple at the end of file. This can become more explicit configuration to ensure consistency by (so that we don't rely on default, which might change): ``` # Ensure single new line at the end of source files. InsertNewlineAtEOF: True KeepEmptyLinesAtEOF: False ``` The commit from Sebastian you've linked has 2 trailing new lines at the end of the `sequencer_clipboard.cc` file, which then got stripped down to a single new line by Bastien's cleanup. We looked into it with Sebastian, and it seems that the `clang_format.py` script does not work well when the new line is inserted by `clang-format`, leading to extra new line adde to the vim's buffer. Using the language-server integration of clang-format does not experience this issue. I also do not experience such issue with neither `make format` nor VS Code with its official clang-format extension. The proposal is: - Add `KeepEmptyLinesAtEOF: False` to the `.clang-format` - Commit the changes to 4.1 - People using `clang_format.py` Vim integration need to ensure the integration properly handles new lines inserted by a formatter

Sebastian Parborg commented

2024-02-16 12:40:44 +01:00

To be more specific, I think that this line is the clang_format.py script is the issue:

stdout.decode(encoding).split('\n')

Here it takes the stdout from clang-format and splits it on every new line.
The script probably didn't anticipate that clang-format would insert a new line before EOF, so in this case it instead thinks that it added a new empty line at the end of the file. And thus we get double new lines.

I switched to using the LSP for formatting, and it now matches make format for me.

To be more specific, I think that this line is the `clang_format.py` script is the issue: ``` stdout.decode(encoding).split('\n') ``` Here it takes the `stdout` from clang-format and splits it on every new line. The script probably didn't anticipate that clang-format would insert a new line before EOF, so in this case it instead thinks that it added a new empty line at the end of the file. And thus we get double new lines. I switched to using the LSP for formatting, and it now matches `make format` for me.

Brecht Van Lommel commented

2024-02-16 13:34:42 +01:00

@Sergey thanks for looking into this, what you propose sounds good to me.

Sergey Sharybin referenced this pull request

2024-02-16 14:24:50 +01:00

Clang-Format: Ensure single new line at the end of files #118380

Sergey Sharybin referenced this issue from a commit

2024-02-22 14:42:20 +01:00

Clang-Format: Ensure single new line at the end of files

Sign in to join this conversation.

No reviewers