chore: fix typo and syntax error

Author: xiaost

CONTRIBUTING.md

@@ -14,7 +14,7 @@ We use [git-flow](https://nvie.com/posts/a-successful-git-branching-model/) as o
 We are using [Github Issues](https://github.com/cloudwego/netpoll/issues) for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn’t already exist.
 
 ### 2. Reporting New Issues
-Providing a reduced test code is a recommended way for reporting issues. Then can placed in:
+Providing a reduced test code is a recommended way for reporting issues. Then can be placed in:
 - Just in issues
 - [Golang Playground](https://play.golang.org/)
 
@@ -45,9 +45,9 @@ Before you submit your Pull Request (PR) consider the following guidelines:
 
 ## Contribution Prerequisites
 - Our development environment keeps up with [Go Official](https://golang.org/project/).
-- You need fully checking with lint tools before submit your pull request. [gofmt](https://golang.org/pkg/cmd/gofmt/) and [golangci-lint](https://github.com/golangci/golangci-lint)
+- You need to fully check with lint tools before submitting your pull request. [gofmt](https://golang.org/pkg/cmd/gofmt/) and [golangci-lint](https://github.com/golangci/golangci-lint)
 - You are familiar with [Github](https://github.com)
-- Maybe you need familiar with [Actions](https://github.com/features/actions)(our default workflow tool).
+- Maybe you need to be familiar with [Actions](https://github.com/features/actions)(our default workflow tool).
 
 ## Code Style Guides
 - [Effective Go](https://golang.org/doc/effective_go)

connection_errors.go

@@ -24,7 +24,7 @@ import (
 const (
 	// The connection closed when in use.
 	ErrConnClosed = syscall.Errno(0x101)
-	// Read I/O buffer timeout, calling by Connection.Reader
+	// Read I/O buffer timeout, called by Connection.Reader
 	ErrReadTimeout = syscall.Errno(0x102)
 	// Dial timeout
 	ErrDialTimeout = syscall.Errno(0x103)

connection_impl.go

@@ -32,7 +32,7 @@ const (
 	connStateDisconnected = 2
 )
 
-// connection is the implement of Connection
+// connection is the implementation of Connection
 type connection struct {
 	netFD
 	onEvent

connection_lock.go

@@ -53,7 +53,7 @@ const (
 )
 
 type locker struct {
-	// keychain use for lock/unlock/stop operation by who.
+	// keychain used for lock/unlock/stop operation by who.
 	// 0 means unlock, 1 means locked, 2 means stop.
 	keychain [total]int32
 }

connection_onevent.go

@@ -231,7 +231,7 @@ func (c *connection) onProcess(onConnect OnConnect, onRequest OnRequest) (proces
 		if closedBy != none {
 			//  if closed by user when processing, it "may" needs detach
 			needDetach := closedBy == user
-			// Here is a conor case that operator will be detached twice:
+			// Here is a corner case that operator will be detached twice:
 			//   If server closed the connection(client OnHup will detach op first and closeBy=poller),
 			//   and then client's OnRequest function also closed the connection(closeBy=user).
 			// But operator already prevent that detach twice will not cause any problem
@@ -240,7 +240,7 @@ func (c *connection) onProcess(onConnect OnConnect, onRequest OnRequest) (proces
 			return
 		}
 		c.unlock(processing)
-		// Note: Poller's closeCallback call will try to get processing lock failed but here already neer to unlock processing.
+		// Note: Poller's closeCallback call will try to get processing lock failed but here already near to unlock processing.
 		//       So here we need to check connection state again, to avoid connection leak
 		// double check close state
 		if c.status(closing) != 0 && c.lock(processing) {

net_dialer.go

@@ -28,9 +28,9 @@ func DialConnection(network, address string, timeout time.Duration) (connection
 	return defaultDialer.DialConnection(network, address, timeout)
 }
 
-// NewFDConnection create a Connection initialed by any fd
-// It's useful for write unit test for functions have args with the type of netpoll.Connection
-// The typical usage like:
+// NewFDConnection create a Connection initialized by any fd
+// It's useful for writing unit tests for functions that have args with the type of netpoll.Connection
+// The typical usage is like:
 //
 //	rfd, wfd := netpoll.GetSysFdPairs()
 //	rconn, _ = netpoll.NewFDConnection(rfd)

nocopy.go

@@ -265,7 +265,7 @@ const (
 	// which indicate that the buffer node memory is not controlled by itself,
 	// so we cannot reuse the buffer or nocopy read it.
 	readonlyMask uint8 = 1 << 0 // 0000 0001
-	// readonlyMask is used to set nocopyRead mode,
+	// nocopyReadMask is used to set nocopyRead mode,
 	// which indicate that the buffer node has been no copy read and cannot reuse the buffer.
 	nocopyReadMask uint8 = 1 << 1 // 0000 0010
 )

nocopy_linkbuffer.go

@@ -256,7 +256,7 @@ func (b *UnsafeLinkBuffer) readBinary(n int) (p []byte) {
 	// single node
 	if b.isSingleNode(n) {
 		// TODO: enable nocopy read mode when ensure no legacy depend on copy-read
-		// we cannot nocopy read a readonly mode buffer, since readonly buffer's memory is not control by itself
+		// we cannot nocopy read a readonly mode buffer, since readonly buffer's memory is not controlled by itself
 		if !b.read.getMode(readonlyMask) {
 			// if readBinary use no-copy mode, it will cause more memory used but get higher memory access efficiently
 			// for example, if user's codec need to decode 10 strings and each have 100 bytes, here could help the codec
@@ -798,7 +798,7 @@ func newLinkBufferNode(size int) *linkBufferNode {
 var linkedPool = sync.Pool{
 	New: func() interface{} {
 		return &linkBufferNode{
-			refer: 1, // 自带 1 引用
+			refer: 1, // comes with 1 reference
 		}
 	},
 }

poll_default_linux.go

@@ -173,7 +173,7 @@ func (p *defaultPoll) handler(events []epollevent) (closed bool) {
 				var leftRead int
 				// read all left data if peer send and close
 				if leftRead, err = readall(operator, p.barriers[i]); err != nil && !errors.Is(err, ErrEOF) {
-					logger.Printf("NETPOLL: readall(fd=%d)=%d before close: %s", operator.FD, total, err.Error())
+					logger.Printf("NETPOLL: readall(fd=%d)=%d before close: %s", operator.FD, totalRead, err.Error())
 				}
 				totalRead += leftRead
 			}