-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathNotes
108 lines (69 loc) · 2.9 KB
/
Notes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
To Whom it May Concern:
What This Is and How to Work It
-------------------------------
This directory in the FOSSology source tree
(agents/nomos) contains work for a new license analysis agent. This
code originated from a standalone license-scanning tool called Nomos.
At this point in time, the code is not integrated with the rest of FOSSology.
It uses it's own non-standard Makefile to build a single standalone
executable.
To try it out...
% make
% ./nomos <file_to_be_scanned>
The file to be scanned should be a regular file (binary or text). In
particular, it should not be an archive. No unpacking is done; the file
is scanned as is.
There are currently no command-line options.
Note About the Source Code and Impending Changes
------------------------------------------------
Because this code came from another tool similar to FOSSology, but with
different structure and conventions, the process of converting it into
a full-fledged FOSSology agent is ongoing.
With that in mind, comments with "CDB" in them are bread crumbs I've
left in places where I was unsure about a change I made or to note a potential
refinement (CDB == my initials).
To Do's
-------
- Change all trace calls at beginning of functions to use traceFunc()
(defined in util.c)
- Either add a command-line option to set gl.ptswitch or remove all the
PROC_TRACE_SWITCH #ifdefs
- Go back and edit CFLAGS options in Makefile to document and accurately
represent what is still operable.
- Document all Makefile targets
- Remove all HP_INTERNAL and CUSTOMER_VERSION references.
- Check and remove all unused field of the gl global variable structure.
- Migrate to standard FOSSology makefile structure and system.
Changes
-------
[This is not at all complete. There have been a lot of changes.]
- Changed ls_t to licSpec_t.
- Changed lic_t to licText_t.
Questions
---------
- Where the hell is checkstrings script? Do we want it?
- COMMIT_HASH #ifdef stolen from other agent code. Where does this get
#defined?
- Why does nomos set the LANG environment variable?
- Implications of removing custom magic file?
- May want to re-add function validateTools someplace?
- Do we want to keep the Log functionality, but just have the logfile
be in another place? (Right now, the log stuff has been removed.)
- Do we really need the PROC_TRACE_SWITCH compile #define?
#defines Used
-------------
[Also incomplete.]
BRIEF_LIST
SHOW_LOCATION Extra code to pinpoint license location. Should
always be true.
PROC_TRACE
PROC_TRACE_SWITCH Gives command option for tracing on/off
DEBUG
GLOBAL_DEBUG Debug access to global variable structure
MEMORY_TRACING Use Debug Malloc wrapper
STOPWATCH Performance Measurement
TIMING Performance Measurement (code has to be added to
places where you want to measure).
Changes made from my nomos_experimental version
-----------------------------------------------
Remove all code #ifdef'd by USE_MMAP