• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# nghttp2 - HTTP/2 C Library
2
3# Copyright (c) 2012 Tatsuhiro Tsujikawa
4
5# Permission is hereby granted, free of charge, to any person obtaining
6# a copy of this software and associated documentation files (the
7# "Software"), to deal in the Software without restriction, including
8# without limitation the rights to use, copy, modify, merge, publish,
9# distribute, sublicense, and/or sell copies of the Software, and to
10# permit persons to whom the Software is furnished to do so, subject to
11# the following conditions:
12
13# The above copyright notice and this permission notice shall be
14# included in all copies or substantial portions of the Software.
15
16# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23
24man_MANS = nghttp.1 nghttpd.1 nghttpx.1 h2load.1
25
26APIDOCS= \
27	macros.rst \
28	enums.rst \
29	types.rst \
30	nghttp2_check_authority.rst \
31	nghttp2_check_header_name.rst \
32	nghttp2_check_header_value.rst \
33	nghttp2_check_header_value_rfc9113.rst \
34	nghttp2_check_method.rst \
35	nghttp2_check_path.rst \
36	nghttp2_hd_deflate_bound.rst \
37	nghttp2_hd_deflate_change_table_size.rst \
38	nghttp2_hd_deflate_del.rst \
39	nghttp2_hd_deflate_get_dynamic_table_size.rst \
40	nghttp2_hd_deflate_get_max_dynamic_table_size.rst \
41	nghttp2_hd_deflate_get_num_table_entries.rst \
42	nghttp2_hd_deflate_get_table_entry.rst \
43	nghttp2_hd_deflate_hd.rst \
44	nghttp2_hd_deflate_hd_vec.rst \
45	nghttp2_hd_deflate_new.rst \
46	nghttp2_hd_deflate_new2.rst \
47	nghttp2_hd_inflate_change_table_size.rst \
48	nghttp2_hd_inflate_del.rst \
49	nghttp2_hd_inflate_end_headers.rst \
50	nghttp2_hd_inflate_get_dynamic_table_size.rst \
51	nghttp2_hd_inflate_get_max_dynamic_table_size.rst \
52	nghttp2_hd_inflate_get_num_table_entries.rst \
53	nghttp2_hd_inflate_get_table_entry.rst \
54	nghttp2_hd_inflate_hd.rst \
55	nghttp2_hd_inflate_hd2.rst \
56	nghttp2_hd_inflate_new.rst \
57	nghttp2_hd_inflate_new2.rst \
58	nghttp2_http2_strerror.rst \
59	nghttp2_is_fatal.rst \
60	nghttp2_nv_compare_name.rst \
61	nghttp2_option_del.rst \
62	nghttp2_option_new.rst \
63	nghttp2_option_set_builtin_recv_extension_type.rst \
64	nghttp2_option_set_max_deflate_dynamic_table_size.rst \
65	nghttp2_option_set_max_reserved_remote_streams.rst \
66	nghttp2_option_set_max_send_header_block_length.rst \
67	nghttp2_option_set_no_auto_ping_ack.rst \
68	nghttp2_option_set_no_auto_window_update.rst \
69	nghttp2_option_set_no_closed_streams.rst \
70	nghttp2_option_set_no_http_messaging.rst \
71	nghttp2_option_set_no_recv_client_magic.rst \
72	nghttp2_option_set_no_rfc9113_leading_and_trailing_ws_validation.rst \
73	nghttp2_option_set_peer_max_concurrent_streams.rst \
74	nghttp2_option_set_server_fallback_rfc7540_priorities.rst \
75	nghttp2_option_set_user_recv_extension_type.rst \
76	nghttp2_option_set_max_outbound_ack.rst \
77	nghttp2_option_set_max_settings.rst \
78	nghttp2_option_set_stream_reset_rate_limit.rst \
79	nghttp2_pack_settings_payload.rst \
80	nghttp2_priority_spec_check_default.rst \
81	nghttp2_priority_spec_default_init.rst \
82	nghttp2_priority_spec_init.rst \
83	nghttp2_rcbuf_decref.rst \
84	nghttp2_rcbuf_get_buf.rst \
85	nghttp2_rcbuf_incref.rst \
86	nghttp2_rcbuf_is_static.rst \
87	nghttp2_select_next_protocol.rst \
88	nghttp2_session_callbacks_del.rst \
89	nghttp2_session_callbacks_new.rst \
90	nghttp2_session_callbacks_set_before_frame_send_callback.rst \
91	nghttp2_session_callbacks_set_data_source_read_length_callback.rst \
92	nghttp2_session_callbacks_set_error_callback.rst \
93	nghttp2_session_callbacks_set_error_callback2.rst \
94	nghttp2_session_callbacks_set_on_begin_frame_callback.rst \
95	nghttp2_session_callbacks_set_on_begin_headers_callback.rst \
96	nghttp2_session_callbacks_set_on_data_chunk_recv_callback.rst \
97	nghttp2_session_callbacks_set_on_extension_chunk_recv_callback.rst \
98	nghttp2_session_callbacks_set_on_frame_not_send_callback.rst \
99	nghttp2_session_callbacks_set_on_frame_recv_callback.rst \
100	nghttp2_session_callbacks_set_on_frame_send_callback.rst \
101	nghttp2_session_callbacks_set_on_header_callback.rst \
102	nghttp2_session_callbacks_set_on_header_callback2.rst \
103	nghttp2_session_callbacks_set_on_invalid_frame_recv_callback.rst \
104	nghttp2_session_callbacks_set_on_invalid_header_callback.rst \
105	nghttp2_session_callbacks_set_on_invalid_header_callback2.rst \
106	nghttp2_session_callbacks_set_on_stream_close_callback.rst \
107	nghttp2_session_callbacks_set_pack_extension_callback.rst \
108	nghttp2_session_callbacks_set_recv_callback.rst \
109	nghttp2_session_callbacks_set_select_padding_callback.rst \
110	nghttp2_session_callbacks_set_send_callback.rst \
111	nghttp2_session_callbacks_set_send_data_callback.rst \
112	nghttp2_session_callbacks_set_unpack_extension_callback.rst \
113	nghttp2_session_change_extpri_stream_priority.rst \
114	nghttp2_session_change_stream_priority.rst \
115	nghttp2_session_check_request_allowed.rst \
116	nghttp2_session_check_server_session.rst \
117	nghttp2_session_client_new.rst \
118	nghttp2_session_client_new2.rst \
119	nghttp2_session_client_new3.rst \
120	nghttp2_session_consume.rst \
121	nghttp2_session_consume_connection.rst \
122	nghttp2_session_consume_stream.rst \
123	nghttp2_session_create_idle_stream.rst \
124	nghttp2_session_del.rst \
125	nghttp2_session_find_stream.rst \
126	nghttp2_session_get_effective_local_window_size.rst \
127	nghttp2_session_get_effective_recv_data_length.rst \
128	nghttp2_session_get_hd_deflate_dynamic_table_size.rst \
129	nghttp2_session_get_hd_inflate_dynamic_table_size.rst \
130	nghttp2_session_get_last_proc_stream_id.rst \
131	nghttp2_session_get_local_settings.rst \
132	nghttp2_session_get_local_window_size.rst \
133	nghttp2_session_get_next_stream_id.rst \
134	nghttp2_session_get_outbound_queue_size.rst \
135	nghttp2_session_get_remote_settings.rst \
136	nghttp2_session_get_remote_window_size.rst \
137	nghttp2_session_get_root_stream.rst \
138	nghttp2_session_get_stream_effective_local_window_size.rst \
139	nghttp2_session_get_stream_effective_recv_data_length.rst \
140	nghttp2_session_get_stream_local_close.rst \
141	nghttp2_session_get_stream_local_window_size.rst \
142	nghttp2_session_get_stream_remote_close.rst \
143	nghttp2_session_get_stream_remote_window_size.rst \
144	nghttp2_session_get_stream_user_data.rst \
145	nghttp2_session_mem_recv.rst \
146	nghttp2_session_mem_send.rst \
147	nghttp2_session_recv.rst \
148	nghttp2_session_resume_data.rst \
149	nghttp2_session_send.rst \
150	nghttp2_session_server_new.rst \
151	nghttp2_session_server_new2.rst \
152	nghttp2_session_server_new3.rst \
153	nghttp2_session_set_local_window_size.rst \
154	nghttp2_session_set_next_stream_id.rst \
155	nghttp2_session_set_stream_user_data.rst \
156	nghttp2_session_set_user_data.rst \
157	nghttp2_session_terminate_session.rst \
158	nghttp2_session_terminate_session2.rst \
159	nghttp2_session_upgrade.rst \
160	nghttp2_session_upgrade2.rst \
161	nghttp2_session_want_read.rst \
162	nghttp2_session_want_write.rst \
163	nghttp2_set_debug_vprintf_callback.rst \
164	nghttp2_stream_get_first_child.rst \
165	nghttp2_stream_get_next_sibling.rst \
166	nghttp2_stream_get_parent.rst \
167	nghttp2_stream_get_previous_sibling.rst \
168	nghttp2_stream_get_state.rst \
169	nghttp2_stream_get_sum_dependency_weight.rst \
170	nghttp2_stream_get_weight.rst \
171	nghttp2_strerror.rst \
172	nghttp2_submit_altsvc.rst \
173	nghttp2_submit_data.rst \
174	nghttp2_submit_extension.rst \
175	nghttp2_submit_goaway.rst \
176	nghttp2_submit_headers.rst \
177	nghttp2_submit_origin.rst \
178	nghttp2_submit_ping.rst \
179	nghttp2_submit_priority.rst \
180	nghttp2_submit_priority_update.rst \
181	nghttp2_submit_push_promise.rst \
182	nghttp2_submit_request.rst \
183	nghttp2_submit_response.rst \
184	nghttp2_submit_rst_stream.rst \
185	nghttp2_submit_settings.rst \
186	nghttp2_submit_shutdown_notice.rst \
187	nghttp2_submit_trailer.rst \
188	nghttp2_submit_window_update.rst \
189	nghttp2_version.rst
190
191RST_FILES = \
192	README.rst \
193	programmers-guide.rst \
194	nghttp.1.rst \
195	nghttpd.1.rst \
196	nghttpx.1.rst \
197	h2load.1.rst
198
199EXTRA_DIST = \
200	CMakeLists.txt \
201	mkapiref.py \
202	$(RST_FILES) \
203	$(APIDOCS) \
204	sources/index.rst \
205	sources/tutorial-client.rst \
206	sources/tutorial-server.rst \
207	sources/tutorial-hpack.rst \
208	sources/nghttpx-howto.rst \
209	sources/h2load-howto.rst \
210	sources/building-android-binary.rst \
211	sources/contribute.rst \
212	sources/security.rst \
213	_exts/rubydomain/LICENSE.rubydomain \
214	_exts/rubydomain/__init__.py \
215	_exts/rubydomain/rubydomain.py \
216	$(man_MANS) \
217	bash_completion/nghttp \
218	bash_completion/nghttpd \
219	bash_completion/nghttpx \
220	bash_completion/h2load
221
222# Makefile for Sphinx documentation
223#
224
225# You can set these variables from the command line.
226SPHINXOPTS    =
227SPHINXBUILD   ?= sphinx-build
228PAPER         =
229BUILDDIR      = manual
230
231# Internal variables.
232PAPEROPT_a4     = -D latex_paper_size=a4
233PAPEROPT_letter = -D latex_paper_size=letter
234ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
235
236.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
237
238help:
239	@echo "Please use \`make <target>' where <target> is one of"
240	@echo "  html       to make standalone HTML files"
241	@echo "  dirhtml    to make HTML files named index.html in directories"
242	@echo "  singlehtml to make a single large HTML file"
243	@echo "  pickle     to make pickle files"
244	@echo "  json       to make JSON files"
245	@echo "  htmlhelp   to make HTML files and a HTML help project"
246	@echo "  qthelp     to make HTML files and a qthelp project"
247	@echo "  devhelp    to make HTML files and a Devhelp project"
248	@echo "  epub       to make an epub"
249	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
250	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
251	@echo "  text       to make text files"
252	@echo "  man        to make manual pages"
253	@echo "  changes    to make an overview of all changed/added/deprecated items"
254	@echo "  linkcheck  to check all external links for integrity"
255	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
256
257apiref.rst: \
258	$(top_builddir)/lib/includes/nghttp2/nghttp2ver.h \
259	$(top_srcdir)/lib/includes/nghttp2/nghttp2.h
260	for i in $(RST_FILES); do [ -e $(builddir)/$$i ] || cp $(srcdir)/$$i $(builddir); done
261	$(PYTHON) $(top_srcdir)/doc/mkapiref.py \
262	apiref.rst macros.rst enums.rst types.rst . $^
263
264$(APIDOCS): apiref.rst
265
266clean-local:
267	if [ $(srcdir) != $(builddir) ]; then for i in $(RST_FILES); do rm -f $(builddir)/$$i; done fi
268	-rm -f apiref.rst
269	-rm -f $(APIDOCS)
270	-rm -rf $(BUILDDIR)/*
271
272html-local: apiref.rst
273	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
274	@echo
275	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
276
277dirhtml:
278	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
279	@echo
280	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
281
282singlehtml:
283	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
284	@echo
285	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
286
287pickle:
288	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
289	@echo
290	@echo "Build finished; now you can process the pickle files."
291
292json:
293	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
294	@echo
295	@echo "Build finished; now you can process the JSON files."
296
297htmlhelp:
298	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
299	@echo
300	@echo "Build finished; now you can run HTML Help Workshop with the" \
301	      ".hhp project file in $(BUILDDIR)/htmlhelp."
302
303qthelp:
304	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
305	@echo
306	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
307	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
308	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/nghttp2.qhcp"
309	@echo "To view the help file:"
310	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/nghttp2.qhc"
311
312devhelp:
313	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
314	@echo
315	@echo "Build finished."
316	@echo "To view the help file:"
317	@echo "# mkdir -p $$HOME/.local/share/devhelp/nghttp2"
318	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/nghttp2"
319	@echo "# devhelp"
320
321epub:
322	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
323	@echo
324	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
325
326latex:
327	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
328	@echo
329	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
330	@echo "Run \`make' in that directory to run these through (pdf)latex" \
331	      "(use \`make latexpdf' here to do that automatically)."
332
333latexpdf:
334	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
335	@echo "Running LaTeX files through pdflatex..."
336	$(MAKE) -C $(BUILDDIR)/latex all-pdf
337	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
338
339text:
340	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
341	@echo
342	@echo "Build finished. The text files are in $(BUILDDIR)/text."
343
344man: apiref.rst
345	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
346	@echo
347	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
348
349changes:
350	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
351	@echo
352	@echo "The overview file is in $(BUILDDIR)/changes."
353
354linkcheck:
355	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
356	@echo
357	@echo "Link check complete; look for any errors in the above output " \
358	      "or in $(BUILDDIR)/linkcheck/output.txt."
359
360doctest:
361	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
362	@echo "Testing of doctests in the sources finished, look at the " \
363	      "results in $(BUILDDIR)/doctest/output.txt."
364