From 58fe6fdc6ede7709c6d49187fa7f71b2675434f6 Mon Sep 17 00:00:00 2001 From: David Malcolm Date: Thu, 25 May 2017 12:47:21 -0400 Subject: [PATCH 10/38] FIXME: more comments --- gcc/firehose.h | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/gcc/firehose.h b/gcc/firehose.h index 05b252d..7ba08b5 100644 --- a/gcc/firehose.h +++ b/gcc/firehose.h @@ -1,4 +1,4 @@ -/* FIXME. +/* Serialization format for checker results. Copyright (C) 2017 Free Software Foundation, Inc. This file is part of GCC. @@ -20,10 +20,23 @@ along with GCC; see the file COPYING3. If not see #ifndef GCC_FIREHOSE_H #define GCC_FIREHOSE_H +/* "Firehose" is a serialization format for results from code + analysis tools: + + http://firehose.readthedocs.io/en/latest/index.html + + (along with a Python module for working with the format). + + This file implements a set of C++ classes modeling the format, + with support for populating them from a JSON dump, so that we + can lossly serialize diagnostics and other static analysis results. */ + #include "json.h" namespace firehose { +/* A state within a firehose::trace. */ + struct state { state (); @@ -122,7 +135,7 @@ struct failure : public result // TODO }; -/* FIXME. */ +/* A class describing a static analyzer, for use within firehose::metadata. */ struct generator { @@ -135,7 +148,8 @@ struct generator char *m_version; }; -/* FIXME. */ +/* The firehose::metadata class contains metadata about a static analyzer + invocation. */ struct metadata { -- 1.8.5.3