action #112544: [Kernel] Leave an empty line between pod and code in os-autoinst-distri-opensuse libraries - openQA Tests - openSUSE Project Management Tool

Actions

Copy link

action #112544

closed

[Kernel] Leave an empty line between pod and code in os-autoinst-distri-opensuse libraries

Added by acarvajal almost 2 years ago. Updated almost 2 years ago.

Status:

Resolved

Priority:

Normal

Assignee:

ybonatakis

Category:

Enhancement to existing tests

Target version:

Start date:

2022-06-15

Due date:

% Done:

100%

Estimated time:

Difficulty:

Description

While reviewing https://github.com/os-autoinst/os-autoinst-distri-opensuse/pull/15049 a suggestion was made to always leave an empty line between pod and code as some renderers could see the lack of the empty line as malformed.

However most of the libraries in the os-autoinst-distri-opensuse repository do not follow this recommendation, for example:

This ticket intends to track the actions to apply the suggestion to all libraries under https://github.com/os-autoinst/os-autoinst-distri-opensuse/tree/master/lib

Actions

Copy link

Updated by okurz almost 2 years ago

Category set to Enhancement to existing tests

Actions

Copy link

Updated by ybonatakis almost 2 years ago

Subject changed from Leave an empty line between pod and code in os-autoinst-distri-opensuse libraries to [Kernel] Leave an empty line between pod and code in os-autoinst-distri-opensuse libraries
Assignee set to ybonatakis

Actions

Copy link

Updated by ybonatakis almost 2 years ago

Status changed from New to In Progress

i created a small script which search for all the files under lib and then adds a new line for all the matching patterns /=cut\n/sub/

ls -Rf path/os-autoinst-distri-opensuse/lib/**/**/*.pm | while read -r file ; do echo $file; sed -rni '1h;1!H;${g;s:=cut(\nsub):=cut\n\1:g;p;}' $file; done

verify that works with (should return zero unless you have other tmp files under lib)