نام (NAME)

pccritic — بررسی و ارزیابی فایل‌های pkg-config

خلاصه دستور (SYNOPSIS)

pccritic [options] module-or-file ...

توضیحات (DESCRIPTION)

pccritic فایل‌های pc(5) را بررسی می‌کند و یافته‌های کیفی را گزارش می‌دهد، و به هر فایل یک امتیاز از 0 تا 100 و یک رتبه حرفی از A تا F اختصاص می‌دهد. این ابزار هم به عنوان یک راهنمای تعاملی برای توسعه‌دهندگان بسته‌ها و هم به عنوان آزمونی که می‌تواند در فرایند یکپارچه‌سازی مداوم (CI) اجرا شود، طراحی شده است.

هر آرگومان خط فرمان به عنوان یک هدف در نظر گرفته می‌شود. اگر آرگومانی شامل یک خط مورب (اسلش) باشد یا به .pc ختم شود، به عنوان مسیر یک فایل تفسیر می‌شود؛ در غیر این صورت، دقیقاً همانند روشی که pkgconf(1) عمل می‌کند، به عنوان نام یک ماژول از مسیر جستجو تعیین موقعیت می‌شود. فایلی که pkgconf(1) به دلیل جا افتادن یک فیلد الزامی از بارگذاری آن خودداری می‌کند، باز هم مستقیماً اسکن می‌شود تا ناقص‌ترین و خراب‌ترین فایل‌ها نیز بتوانند امتیازدهی شوند.

یافته‌ها بر اساس میزان اهمیت و شدت دسته‌بندی می‌شوند. امتیاز از 100 آغاز می‌شود و هر یافته جریمه مشخصی را کسر می‌کند: 25 برای یک یافته critical (بحرانی)، 10 برای یک یافته major (عمده)، 4 برای یک یافته minor (جزئی)، و 1 برای یک یافته info (اطلاعاتی). نتیجه نهایی در محدوده 0 تا 100 محدود می‌شود. رتبه‌ها به صورت A برای 90 و بالاتر، B برای 80، C برای 70، D برای 60، و F برای کمتر از 60 اختصاص می‌یابند.

این ارزیابی‌ها شامل متاداده‌های الزامی و توصیه‌شده، صحت نسخه، قابلیت جابه‌جایی متغیرهای libdir و includedir ، سلامت فیلدهای Cflags و Libs ، ارتباط میان Requires و Requires.private ، و شیوه قالب‌بندی پایه فایل است.

گزینه‌ها (OPTIONS)

گزینه‌ها به شرح زیر هستند:

--about

شماره نسخه، اعلان حق نشر (کپی‌رایت) و مجوز برنامه pccritic را در خروجی استاندارد چاپ کرده و خارج می‌شود.

--version

شماره نسخه برنامه pccritic را در خروجی استاندارد چاپ کرده و خارج می‌شود.

--help

یک خلاصه کوتاه از نحوه استفاده را در خروجی استاندارد چاپ کرده و خارج می‌شود.

--quiet

به جای فهرست کامل یافته‌ها، تنها امتیاز و رتبه هر هدف را در یک سطر جداگانه چاپ می‌کند.

--min-score n

در صورتی که امتیاز هر هدفی کمتر از n باشد، با وضعیتی غیرصفر خارج می‌شود. این گزینه برای ناموفق کردن یک فرایند یکپارچه‌سازی مداوم هنگام افت کیفیت فایل به زیر یک حد آستانه مفید است.

--color[=when]

خروجی رنگی را کنترل می‌کند. when می‌تواند auto (پیش‌فرض)، always یا never باشد. در حالت auto ، رنگ تنها زمانی فعال است که خروجی استاندارد یک ترمینال باشد و متغیر محیطی NO_COLOR تنظیم نشده باشد. ارائه گزینه --color بدون مقدار، معادل always است.

--define-variable=varname=value

متغیر varname را با مقدار value تعریف می‌کند. این امر بر نحوه گسترش متغیرها در فایل مورد بررسی تأثیر می‌گذارد.

وضعیت خروج (EXIT STATUS)

pccritic در صورت موفقیت با وضعیت 0 خارج می‌شود. اگر بارگذاری یک هدف امکان‌پذیر نباشد، خط فرمان نامعتبر باشد، یا گزینه --min-score مشخص شده و امتیاز یک هدف کمتر از حد آستانه باشد، با وضعیت غیرصفر خارج می‌شود.

مثال‌ها (EXAMPLES)

امتیازدهی به یک ماژول نصب‌شده بر اساس نام:

امتیازدهی به یک فایل پیش از نصب و خروج با خطا در صورت کسب رتبه پایین‌تر از C:

خلاصه‌سازی وضعیت تمامی فایل‌های موجود در یک دایرکتوری:

همچنین ببینید (SEE ALSO)

pkgconf(1), pc(5)

نویسندگان (AUTHORS)

pccritic توسط نویسندگان pkgconf نوشته شده است.