aishpant / attribute-documentation Goto Github PK

Right now for cleaning up temporary generated files, abi2doc uses:

def remove_temp_files():
    for p in Path("/tmp/").glob("*.cocci"):
        p.unlink()

This clean-up should be more specfic, It should look for /tmp/batch_task_*.cocci and /tmp/out.batch_task_*.cocci instead.

This line in doc.py fails with an index out of bounds error:
kernel_version = sorted(tags, key=StrictVersion)[0]

Error should be caught and handled.

Makes it easy to read and manage...

Two places need to be updated:

• Ubuntu like distributions still default python & pip to be python2.7 and pip2.7 respectively. Package download instruction should change to : pip3 install abi2doc
• spatch needs to be compiled with option ./configure --with-python=python3. README should direct coccinelle install instructions to the github repo since all the distro packages are outdated now.

Refer to comment in commit "use system cpu count to run spatch" .

Mutating variables outside the scope of a function is in general a bad idea.

• You cannot move this function elsewhere now, because its tied up to the environment
• You cannot unit test this function without mocking a global object
• You have another function (or parts of code) that is implicitly depending on this function being called before, but that is not very clear when you read the code.
• Mutation in general makes code harder to understand

Reported by: @jaseemabid.

Use a linter like flake8 to weed out coding style issues / bug fixes in the python files.
There might be lots!

Some print statements are for debugging purpose and they should be printed in verbose mode only.

This should be corrected to match the developer's machine

The git log -L command in doc.py takes a very long time to run. The script would be much faster if it runs in parallel.