Documentation cleanup

This commit is contained in:
Trustin Lee 2008-11-14 06:32:10 +00:00
parent 8b3956b238
commit 3d83768039

View File

@ -6,21 +6,21 @@
<preface id="preface"> <preface id="preface">
<title>Preface</title> <title>Preface</title>
<para> <para>
The most fundamental question, <quote>What is Netty and why should I This guide provides an introduction to <ulink url="&Home;">Netty</ulink>
care?</quote>, will be answered here. and what it is about.
</para> </para>
<section> <section>
<title>The Problem</title> <title>The Problem</title>
<para> <para>
We are using a general purpose application or library to communicate Nowadays we use general purpose applications or libraries to communicate
with each other nowadays. For example, we often use an open source with each other. For example, we often use an open source HTTP client
HTTP client library to retrieve information from an open source web library to retrieve information from an open source web server and to
server and to invoke a remote procedure call via web services. invoke a remote procedure call via web services.
</para> </para>
<para> <para>
However, a general purpose protocol or its implementation sometimes However, a general purpose protocol or its implementation sometimes
doesn't scale very well. It's like we don't use a general purpose does not scale very well. It is like we don't use a general purpose
HTTP server to exchange huge files, e-mail messages, and near-realtime HTTP server to exchange huge files, e-mail messages, and near-realtime
messages such as financial information and multiplayer game data. messages such as financial information and multiplayer game data.
What's required is a highly optimized protocol implementation which is What's required is a highly optimized protocol implementation which is
@ -54,7 +54,7 @@
programming such as TCP/IP socket server development. programming such as TCP/IP socket server development.
</para> </para>
<para> <para>
'Quick and easy' doesn't mean that a resulting application will suffer 'Quick and easy' does not mean that a resulting application will suffer
from a maintainability or a performance issue. Netty has been designed from a maintainability or a performance issue. Netty has been designed
carefully with the experiences earned from the implementation of a lot carefully with the experiences earned from the implementation of a lot
of protocols such as FTP, SMTP, HTTP, and various binary and text-based of protocols such as FTP, SMTP, HTTP, and various binary and text-based
@ -63,14 +63,14 @@
without a compromise. without a compromise.
</para> </para>
<para> <para>
Some of you might already have found other network application Some users might already have found other network application
framework that claims to have the same advantage, and you might want framework that claims to have the same advantage, and you might want
to ask what makes Netty so different from them. The answer is the to ask what makes Netty so different from them. The answer is the
philosophy where it is built on. It's designed to give you the most philosophy where it is built on. Netty is designed to give you the most
comfortable experience both in terms of the API and the implementation comfortable experience both in terms of the API and the implementation
from the day one. It's not something tangible but you will get to from the day one. It is not something tangible but you will realize that
realize that this philosophy will make your life much easier as you this philosophy will make your life much easier as you read this guide
read this guide on and play with Netty. and play with Netty.
</para> </para>
</section> </section>
</preface> </preface>