Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some formatting cleanup, remove trailing space characters and POSIX compliance #208

Merged
merged 3 commits into from
Sep 18, 2020

Conversation

aaronfranke
Copy link
Contributor

@aaronfranke aaronfranke commented Sep 15, 2020

This PR does a few things related to file formatting:

  • Remove trailing space characters. These are useless and just take up disk space. For most files I know off the top of my head that the change is fine, however, I wasn't sure about whether this is good for the .adoc and .1 files, so I put the changes to those files in a 2nd commit with "(unsure)" at the end. If these are desired, I can squash them down.

  • Ensure text files end in trailing newline characters. These are important for POSIX-compliance, since by POSIX definition a text file must end in a newline. Some Linux/Mac tools don't work properly without them present, including terminal apps and some C compilers. Also, GitHub shows a 🚫 warning for files that don't end in newlines.

  • There were a few files that mistakenly contained BOMs, I removed them. BOMs are usually undesired.

I made these changes using a script. In case I need to rebase this PR, it is very easy to re-run the script I used. Additionally, if desired, I can add the script to the CI checks, so that these formatting checks are done automatically.

@CLAassistant
Copy link

CLAassistant commented Sep 15, 2020

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@rpavlik rpavlik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome, thanks! We'd love to have the script added - I had thought the gitattributes and the editorconfig files would take care of most of these things, but I will admit the cyclical disappearance-reappearance of the BOM in the xr.xml file is an annoying frustration...

I'd rather not touch the files in the license directory or the external files, but it seems strange they'd have trailing whitespace anyway, so I think it's probably fine. It might just happen again next time I update deps.

@rpavlik rpavlik merged commit 3cdc1b0 into KhronosGroup:master Sep 18, 2020
@aaronfranke aaronfranke deleted the formatting branch September 18, 2020 22:58
rpavlik added a commit that referenced this pull request Sep 26, 2020
This release features a number of new ratified KHR extensions, as well
as a new vendor extension.

-   Registry
    -   Add ratified XR_KHR_vulkan_enable2 Khronos extension. (internal
        MR 1627, internal issue 1249, internal issue 1283, internal MR
        1863)
    -   Add ratified XR_KHR_loader_init Khronos extension. (internal MR
        1744)
    -   Add ratified XR_KHR_loader_init_android Khronos extension.
        (internal MR 1744)
    -   Add ratified XR_KHR_composition_layer_equirect2 Khronos
        extension. (internal MR 1746)
    -   Add ratified XR_KHR_composition_layer_color_scale_bias Khronos
        extension. (internal MR 1762)
    -   Add XR_MSFT_controller_model extension. (internal MR 1832)
    -   Add vendor tag LIV for LIV Inc. (internal MR 1896)
    -   Fix structextends attribute of XrHandPoseTypeInfoMSFT.
        (OpenXR-SDK-Source/#207)
    -   schema: Update to permit aliases for commands and struct types.
        (Already supported by tooling.) (internal MR 1627)
-   SDK
    -   cmake: fix openxr_loader target export when installing both
        Release and Debug config on Windows. (OpenXR-SDK-Source/#206)
    -   hello_xr: Support the new XR_KHR_vulkan_enable2 extension.
        (internal MR 1627)
    -   hello_xr: Use the XR_KHR_loader_init_android extension on
        Android. (internal MR 1903)
    -   layers: Fix ARM builds by re-adding function attributes.
        (OpenXR-SDK-Source/#193)
-   Misc
    -   Clean up trailing whitespace, byte-order marks, anda ensure
        trailing newlines. (OpenXR-SDK-Source/#208)
rhabacker pushed a commit to rhabacker/OpenXR-SDK-Source that referenced this pull request Nov 16, 2022
This release features a number of new ratified KHR extensions, as well
as a new vendor extension.

-   Registry
    -   Add ratified XR_KHR_vulkan_enable2 Khronos extension. (internal
        MR 1627, internal issue 1249, internal issue 1283, internal MR
        1863)
    -   Add ratified XR_KHR_loader_init Khronos extension. (internal MR
        1744)
    -   Add ratified XR_KHR_loader_init_android Khronos extension.
        (internal MR 1744)
    -   Add ratified XR_KHR_composition_layer_equirect2 Khronos
        extension. (internal MR 1746)
    -   Add ratified XR_KHR_composition_layer_color_scale_bias Khronos
        extension. (internal MR 1762)
    -   Add XR_MSFT_controller_model extension. (internal MR 1832)
    -   Add vendor tag LIV for LIV Inc. (internal MR 1896)
    -   Fix structextends attribute of XrHandPoseTypeInfoMSFT.
        (OpenXR-SDK-Source/KhronosGroup#207)
    -   schema: Update to permit aliases for commands and struct types.
        (Already supported by tooling.) (internal MR 1627)
-   SDK
    -   cmake: fix openxr_loader target export when installing both
        Release and Debug config on Windows. (OpenXR-SDK-Source/KhronosGroup#206)
    -   hello_xr: Support the new XR_KHR_vulkan_enable2 extension.
        (internal MR 1627)
    -   hello_xr: Use the XR_KHR_loader_init_android extension on
        Android. (internal MR 1903)
    -   layers: Fix ARM builds by re-adding function attributes.
        (OpenXR-SDK-Source/KhronosGroup#193)
-   Misc
    -   Clean up trailing whitespace, byte-order marks, anda ensure
        trailing newlines. (OpenXR-SDK-Source/KhronosGroup#208)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants