[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

External file structure


  • To: "fusa-sig@xxxxxxxxxxxxxxxxxxxx" <fusa-sig@xxxxxxxxxxxxxxxxxxxx>
  • From: Luca Fancellu <Luca.Fancellu@xxxxxxx>
  • Date: Mon, 23 Jan 2023 10:28:32 +0000
  • Accept-language: en-GB, en-US
  • Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=arm.com; dmarc=pass action=none header.from=arm.com; dkim=pass header.d=arm.com; arc=none
  • Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=EkcM1rV/lIRq0+GlUJGoZr1kORW5FLODj3fT1POTQbQ=; b=HFSG//Mv6/5M0SwIcNRKdaWH+rDzYVRIoqWVhIqvqIuJyl0J/qqkYXM1XWJLKsTpa0Vbw2bKsitCxxvgp98259KWDyId3kljSOgzgzgFkFILi5PTlPzrhFWRcXqKBKoLXVKmCNXs7IEWaA82qZRkdLAHJgUIL28cFClJgXU3l0e+NkdggRNB6mEz3aPVmlxGOaQI1xjF3+gaCmA4bAkv6Hn7vSgoJcYMJpmnqBXZfyGCMKW6Wm70LYHEPchoSbOVySMd6G1cle5EmIvXLsa3hS8PG6R9IjBIh1A0QFnyat/6RBt+IcRLzuu5OFiRbWdXlKa0gWHWss8SGPsGhyUD1Q==
  • Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=Sy5fo8Vw3s0VstU0z9Txk9AB1iciqdMLAIBvRVYivAQqGwOfoNSlLDKfpIwtIdnelcy+48vaThjcsdsUqvwvSjgruSj7/0DSVgx6ceCisdLrng0VVslb1Mx1axFMTnCrX/bMlLn4GC4JQaQ0xGe8CetjWkfFDxDObm0NTqm8FQSERwFAfiktxR/GB2xViiTIcVFNngfDrfGNQbNCxkRxoSyuYOYlPX4Nk3OP5s3f2ToAbyEZ+ePmNzgp6pVXYK6kh0K4NhGzXHiDWQDdBqNgYHRAWKWpiGudb1oNOcIBSFKybg3cdmJCS+fBpqJ9SvNvbd8p5Rgyi1Wh1y1ayJTmJw==
  • Authentication-results-original: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=arm.com;
  • Cc: Michal Orzel <michal.orzel@xxxxxxx>, Stefano Stabellini <sstabellini@xxxxxxxxxx>, Bertrand Marquis <Bertrand.Marquis@xxxxxxx>
  • Delivery-date: Mon, 23 Jan 2023 10:28:55 +0000
  • List-id: This is a discussion list for members of the Xen Project FuSa SIG <fusa-sig.lists.xenproject.org>
  • Nodisclaimer: true
  • Original-authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=arm.com;
  • Thread-index: AQHZLxVws52BRDcU90CHFb9kmFQe6Q==
  • Thread-topic: External file structure

Hi all,

I’m starting a proposal for the external files that needs to be removed from 
the MISRA scan,
the work was originally started by Michal here:
https://patchwork.kernel.org/project/xen-devel/patch/20221116092032.4423-1-michal.orzel@xxxxxxx/
so I started by that thread, the aim of this work is to have an initial format 
to start as soon as possible to
exclude the external files from the MISRA scan.

I think we can use the JSON format because it’s easy to integrate it with 
python and it’s easy to add/remove
fields from the structure without interfering with the other elements during 
time, so we can define a structure
now but if in the future we see the needs for additional field, we can just add 
them without changes to the
analysis script.

In my opinion many of these fields can be left empty in a first push, to let 
the script exclude the files and during
time with the contributions of the community we can add the missing 
informations.
I think it’s easier for the community to pick an entry, do some research to 
fill the gaps and push, instead to wait
until having all the informations before adding the entry.


This is my first though for the fields, let me know yours:

docs/misra/external-files.json:
{
  "version": "1.0”,
  "content": [
    {
      "path": "relative/path/from/xen/“,
      "diverged": false,
      "backport": "Y/N/?",
      "origin_project": "URL to origin project",
      "origin_path": "relative path in the original project",
      "origin_revision": "revision in original project”
    }
  ]
}


Maybe, documentation for this file and the fields can reside in 
docs/misra/documenting-violations.rst, or
in a separate rst file in that folder.

Cheers,
Luca


 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.