fsfe / reuse-tool

reuse is a tool for compliance with the REUSE recommendations.
https://reuse.software
399 stars 148 forks source link

Review assembly comment default syntax #927

Closed monacofj closed 6 months ago

monacofj commented 7 months ago

The suffix .s is the default extension for assembly code used by the GNU tool-chain. GCC outputs foo.s out of foo.c if the command-line option -S is selected. The GNU Assembler (GAS), which reads the .s file as input, expects Python-style comments (in x86 platform). Also, GAS manual recommends .s (lowercase) for compiler-generated code, and .S (uppercase) for human-written code.

On the other hand, the suffix .asm is commonly used for assembly code meant for the NASM assembler, which uses Lisp-style comments.

Currently, reuse treats .s files as if they were in NASM syntax, and by add lisp-style comments, causes projects that rely on the GNU tools fail to build.

Suggestion: it might be more intuitive and practical for most programmers if

monacofj commented 7 months ago

Tentative fix in #928.