summary refs log tree commit diff
path: root/www/text.causal.agency/004-uloc.7
blob: edd78d808569058fe55213522aa8e9ced22d0ad1 (plain) (blame)
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
.Dd December 14, 2018
.Dt ULOC 7
.Os "Causal Agency"
.
.Sh NAME
.Nm ULOC
.Nd unique lines of code
.
.Sh DESCRIPTION
There are many tools available
which measure SLOC: source lines of code.
These tools are strangely complex
for what they intend to do,
which is to estimate the relative sizes of projects.
They perform some amount of parsing
in order to discount comments in various languages,
and for reasons unknown each format their ouput
in some oddly encumbered way.
.
.Pp
I propose a much simpler method
of estimating relative sizes of projects:
unique lines of code.
ULOC can be calculated with standard tools as follows:
.
.Bd -literal -offset indent
sort -u *.h *.c | wc -l
.Ed
.
.Pp
In my opinion,
the number this produces
should be a better estimate of
the complexity of a project.
Compared to SLOC,
not only are blank lines discounted,
but so are close-brace lines
and other repetitive code
such as common includes.
On the other hand,
ULOC counts comments,
which require just as much maintenance
as the code around them does,
while avoiding inflating the result
with license headers which appear in every file,
for example.
.
.Pp
It can also be amusing
to read all of your code sorted alphabetically.
.
.Sh AUTHORS
.An Mt june@causal.agency
.
.Pp
This document is produced from
.Xr mdoc 7
source available from
.Lk https://git.causal.agency/src/tree/www/text.causal.agency
.
.Sh CAVEATS
Estimates such as these
should not be used for decision making
as if they were data.
lass='logheader'>2019-02-18Remove hi line numberingJune McEnroe Tags are much better for referring to specific parts of a file and line numbering is better done by a post-processing tool such as cat -n or producing a two-column HTML <table>. 2019-02-18Add Tag class to hiJune McEnroe 2019-02-17Generate HTML with hi -n -f html -o anchorJune McEnroe Running hi twice to insert stuff between the head and the content is a bit of a hack but oh well. 2019-02-17Add hi -f html -o anchor for line number linksJune McEnroe 2019-02-17Simplify temp trap in upJune McEnroe 2019-02-17Add line numbers to hiJune McEnroe Renames previous -n option to -m to stay consistent with cat -n. Prefixing lines with line numbers affects where the first tab indent ends up relative to the text above it. Not sure if it's worth fixing somehow. 2019-02-17Always split spans after newlinesJune McEnroe Simplifies ANSI and IRC output code, and prepares for line numbered output. 2019-02-15Color format specifiers light cyan in vimJune McEnroe 2019-02-15Highlight Interp as yellowJune McEnroe 2019-02-15Highlight strings in sh command substitutionsJune McEnroe 2019-02-15Add nmap gpJune McEnroe 2019-02-14Avoid newline when copying URL to pasteboardJune McEnroe 2019-02-13Add forgotten "sixth" book of H2G2June McEnroe