kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gwens...@apache.org
Subject kafka git commit: MINOR: Add header and footer to protocol docs
Date Thu, 10 Mar 2016 18:45:11 GMT
Repository: kafka
Updated Branches:
  refs/heads/trunk 83f714bae -> 1a451b481


MINOR: Add header and footer to protocol docs

Because protocol.html is going to be in its own page it needs the header and footer included.

Author: Grant Henke <granthenke@gmail.com>

Reviewers: Gwen Shapira

Closes #1043 from granthenke/protocol-docs-style


Project: http://git-wip-us.apache.org/repos/asf/kafka/repo
Commit: http://git-wip-us.apache.org/repos/asf/kafka/commit/1a451b48
Tree: http://git-wip-us.apache.org/repos/asf/kafka/tree/1a451b48
Diff: http://git-wip-us.apache.org/repos/asf/kafka/diff/1a451b48

Branch: refs/heads/trunk
Commit: 1a451b4812ae2502bb6bc105e77eb00175a76ec5
Parents: 83f714b
Author: Grant Henke <granthenke@gmail.com>
Authored: Thu Mar 10 10:44:58 2016 -0800
Committer: Gwen Shapira <cshapi@gmail.com>
Committed: Thu Mar 10 10:44:58 2016 -0800

----------------------------------------------------------------------
 docs/protocol.html | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kafka/blob/1a451b48/docs/protocol.html
----------------------------------------------------------------------
diff --git a/docs/protocol.html b/docs/protocol.html
index 98923aa..cb359f1 100644
--- a/docs/protocol.html
+++ b/docs/protocol.html
@@ -1,3 +1,22 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!--#include virtual="../includes/header.html" -->
+
 <h3><a id="protocol" href="#protocol">Kafka Wire Protocol</a></h3>
 
 <p>This document covers the wire protocol implemented in Kafka. It is meant to give
a readable guide to the protocol that covers the available requests, their binary format,
and the proper way to make use of them to implement a client. This document assumes you understand
the basic design and terminology described <a href="https://kafka.apache.org/documentation.html#design">here</a></p>
@@ -160,4 +179,4 @@ Size => int32
 
 <p>A final question is why we don't use a system like Protocol Buffers or Thrift to
define our request messages. These packages excel at helping you to managing lots and lots
of serialized messages. However we have only a few messages. Support across languages is somewhat
spotty (depending on the package). Finally the mapping between binary log format and wire
protocol is something we manage somewhat carefully and this would not be possible with these
systems. Finally we prefer the style of versioning APIs explicitly and checking this to inferring
new values as nulls as it allows more nuanced control of compatibility.</p>
 
-
+<!--#include virtual="../includes/footer.html" -->


Mime
View raw message