Skip to content

Commit d672551

Browse files
HACKING: Drop from the git repository
Despite being a generated file, HACKING has been tracked in the git repository along with actual source files. As far as I'm aware, it's the only generated file for which that happens. Times and times again, people[1] have committed changes to the source file without refreshing the generated copy at the same time. The rationale for tracking the generated file is to help out people who just cloned the git repository looking to contribue; however, README-hacking already contains enough information to get perspective contributors to a place where they can simply look at docs/hacking.html instead. [1] Mostly me, to be honest Signed-off-by: Andrea Bolognani <[email protected]>
1 parent e49f2f9 commit d672551

File tree

8 files changed

+9
-1315
lines changed

8 files changed

+9
-1315
lines changed

HACKING

Lines changed: 0 additions & 1112 deletions
This file was deleted.

Makefile.am

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -66,17 +66,6 @@ EXTRA_DIST += \
6666
$(srcdir)/docs/news-ascii.xsl \
6767
$(srcdir)/docs/reformat-news.py
6868

69-
$(top_srcdir)/HACKING: $(top_srcdir)/docs/hacking1.xsl \
70-
$(top_srcdir)/docs/hacking2.xsl \
71-
$(top_srcdir)/docs/wrapstring.xsl \
72-
$(top_srcdir)/docs/hacking.html.in
73-
$(AM_V_GEN)if [ -x $(XSLTPROC) ] ; then \
74-
$(XSLTPROC) --nonet $(top_srcdir)/docs/hacking1.xsl \
75-
$(top_srcdir)/docs/hacking.html.in | \
76-
$(XSLTPROC) --nonet $(top_srcdir)/docs/hacking2.xsl - \
77-
| perl -0777 -pe 's/\n\n+$$/\n/' \
78-
> $@-t && mv $@-t $@ ; fi;
79-
8069
rpm: clean
8170
@(unset CDPATH ; $(MAKE) dist && rpmbuild -ta $(distdir).tar.xz)
8271

README-hacking

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
These notes intend to help people working on the checked-out sources.
44
These requirements do not apply when building from a distribution tarball.
5-
See also HACKING for more detailed libvirt contribution guidelines.
5+
See also docs/hacking.html (after building libvirt using the information
6+
included in this file) for more detailed contribution guidelines.
67

78
* Requirements
89

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,7 @@ Contributing
6464

6565
The libvirt project welcomes contributions in many ways. For most components
6666
the best way to contribute is to send patches to the primary development
67-
mailing list. Further guidance on this can be found in the `HACKING` file
68-
or on the website:
67+
mailing list. Further guidance on this can be found on the website:
6968

7069
[https://libvirt.org/contribute.html](https://libvirt.org/contribute.html)
7170

cfg.mk

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ endif
9191

9292
# Files that should never cause syntax check failures.
9393
VC_LIST_ALWAYS_EXCLUDE_REGEX = \
94-
(^(HACKING|docs/(news(-[0-9]*)?\.html\.in|.*\.patch))|\.(po|fig|gif|ico|png))$$
94+
(^(docs/(news(-[0-9]*)?\.html\.in|.*\.patch))|\.(po|fig|gif|ico|png))$$
9595

9696
# Functions like free() that are no-ops on NULL arguments.
9797
useless_free_options = \
@@ -910,12 +910,11 @@ sc_curly_braces_style:
910910
'^\s*(?!([a-zA-Z_]*for_?each[a-zA-Z_]*) ?\()([_a-zA-Z0-9]+( [_a-zA-Z0-9]+)* ?\()?(\*?[_a-zA-Z0-9]+(,? \*?[_a-zA-Z0-9\[\]]+)+|void)\) ?\{' \
911911
$$files; then \
912912
echo '$(ME): Non-K&R style used for curly braces around' \
913-
'function body, see HACKING' 1>&2; exit 1; \
913+
'function body' 1>&2; exit 1; \
914914
fi; \
915915
if $(GREP) -A1 -En ' ((if|for|while|switch) \(|(else|do)\b)[^{]*$$'\
916916
$$files | $(GREP) '^[^ ]*- *{'; then \
917-
echo '$(ME): Use hanging braces for compound statements,' \
918-
'see HACKING' 1>&2; exit 1; \
917+
echo '$(ME): Use hanging braces for compound statements' 1>&2; exit 1; \
919918
fi
920919

921920
sc_prohibit_windows_special_chars_in_filename:
@@ -1067,9 +1066,8 @@ _autogen:
10671066
_autogen_error:
10681067
$(srcdir)/autogen.sh --dry-run
10691068

1070-
# regenerate HACKING as part of the syntax-check
10711069
ifneq ($(_gl-Makefile),)
1072-
syntax-check: $(top_srcdir)/HACKING spacing-check test-wrap-argv \
1070+
syntax-check: spacing-check test-wrap-argv \
10731071
prohibit-duplicate-header mock-noinline
10741072
endif
10751073

@@ -1081,8 +1079,7 @@ prohibit-duplicate-header:
10811079
spacing-check:
10821080
$(AM_V_GEN)files=`$(VC_LIST) | grep '\.c$$'`; \
10831081
$(PERL) $(top_srcdir)/build-aux/check-spacing.pl $$files || \
1084-
{ echo '$(ME): incorrect formatting, see HACKING for rules' 1>&2; \
1085-
exit 1; }
1082+
{ echo '$(ME): incorrect formatting' 1>&2; exit 1; }
10861083

10871084
mock-noinline:
10881085
$(AM_V_GEN)files=`$(VC_LIST) | grep '\.[ch]$$'`; \

docs/Makefile.am

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ schema_DATA = $(wildcard $(srcdir)/schemas/*.rng)
172172
EXTRA_DIST= \
173173
apibuild.py genaclperms.pl \
174174
site.xsl subsite.xsl newapi.xsl page.xsl \
175-
hacking1.xsl hacking2.xsl wrapstring.xsl \
175+
wrapstring.xsl \
176176
$(dot_html) $(dot_html_in) $(gif) $(apihtml) $(apipng) \
177177
$(devhelphtml) $(devhelppng) $(devhelpcss) $(devhelpxsl) \
178178
$(xml) $(qemu_xml) $(lxc_xml) $(admin_xml) $(fig) $(png) $(css) \

docs/hacking1.xsl

Lines changed: 0 additions & 40 deletions
This file was deleted.

docs/hacking2.xsl

Lines changed: 0 additions & 140 deletions
This file was deleted.

0 commit comments

Comments
 (0)