optimize README.md

Author: loongs-zhang

.github/workflows/ci.yml

@@ -4,9 +4,11 @@ on:
   push:
     paths-ignore:
       - '**.md'
+      - '**.png'
   pull_request:
     paths-ignore:
       - '**.md'
+      - '**.png'
 
 env:
   CARGO_TERM_COLOR: always

.github/workflows/coverage.yml

@@ -0,0 +1,48 @@
+name: Code Coverage
+
+on:
+  push:
+    paths-ignore:
+      - '**.md'
+      - '**.png'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - '**.png'
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: nightly-2024-08-02
+          override: true
+      - name: Build
+        run: cargo build --release --all-features --all --verbose
+      - name: Run tests
+        run: cargo test --release --all-features --all --verbose
+        env:
+          CARGO_INCREMENTAL: '0'
+          RUSTFLAGS: '-Zprofile -Ccodegen-units=1 -Cllvm-args=--inline-threshold=0 -Clink-dead-code -Coverflow-checks=off -Cpanic=abort -Zpanic_abort_tests'
+          RUSTDOCFLAGS: '-Zprofile -Ccodegen-units=1 -Cllvm-args=--inline-threshold=0 -Clink-dead-code -Coverflow-checks=off -Cpanic=abort -Zpanic_abort_tests'
+      - name: rust-grcov
+        # You may pin to the exact commit or the version.
+        # uses: actions-rs/grcov@bb47b1ed7883a1502fa6875d562727ace2511248
+        uses: actions-rs/[email protected]
+      - name: Codecov
+        # You may pin to the exact commit or the version.
+        # uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378
+        uses: codecov/codecov-action@v5
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_ORG_TOKEN }}
+        with:
+          # Repository upload token - get it from codecov.io. Required only for private repositories
+          # token: # optional
+          # Specify whether the Codecov output should be verbose
+          verbose: true
+          fail_ci_if_error: true

.travis.yml

@@ -0,0 +1,37 @@
+language: rust
+
+sudo: required
+
+rust:
+  - stable
+  - nightly
+
+matrix:
+  allow_failures:
+    - rust: nightly
+
+addons:
+  apt:
+    packages:
+      - libcurl4-openssl-dev
+      - libelf-dev
+      - libdw-dev
+      - cmake
+      - gcc
+      - binutils-dev
+      - libiberty-dev
+
+after_success: |
+  wget https://github.com/SimonKagstrom/kcov/archive/master.tar.gz &&
+  tar xzf master.tar.gz &&
+  cd kcov-master &&
+  mkdir build &&
+  cd build &&
+  cmake .. &&
+  make &&
+  make install DESTDIR=../../kcov-build &&
+  cd ../.. &&
+  rm -rf kcov-master &&
+  for file in target/release/open-coroutine-*; do [ -x "${file}" ] || continue; mkdir -p "target/cov/$(basename $file)"; ./kcov-build/usr/local/bin/kcov --exclude-pattern=/.cargo,/usr/lib --verify "target/cov/$(basename $file)" "$file"; done &&
+  bash <(curl -s https://codecov.io/bash) &&
+  echo "Uploaded code coverage"

README.md

@@ -1,5 +1,12 @@
 # open-coroutine
 
+[![crates.io](https://img.shields.io/crates/v/open-coroutine.svg)](https://crates.io/crates/open-coroutine)
+[![LICENSE](https://img.shields.io/github/license/acl-dev/open-coroutine.svg?style=flat-square)](https://github.com/acl-dev/open-coroutine/blob/master/LICENSE-APACHE)
+[![Build Status](https://github.com/acl-dev/open-coroutine/workflows/CI/badge.svg)](https://github.com/acl-dev/open-coroutine/actions)
+[![Codecov](https://codecov.io/github/acl-dev/open-coroutine/graph/badge.svg?token=MSM3R7CBEX)](https://codecov.io/github/acl-dev/open-coroutine)
+[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/acl-dev/open-coroutine.svg)](http://isitmaintained.com/project/acl-dev/open-coroutine "Average time to resolve an issue")
+[![Percentage of issues still open](http://isitmaintained.com/badge/open/acl-dev/open-coroutine.svg)](http://isitmaintained.com/project/acl-dev/open-coroutine "Percentage of issues still open")
+
 The `open-coroutine` is a simple, efficient and generic stackful-coroutine library.
 
 <div style="text-align: center;">

core/src/common/macros.rs

@@ -1,4 +1,4 @@
-/// Check <https://www.rustwiki.org.cn/en/reference/introduction.html> for help information.
+//! Check <https://www.rustwiki.org.cn/en/reference/introduction.html> for help information.
 
 /// Constructs an event at the trace level.
 #[allow(unused_macros)]

core/src/common/mod.rs

@@ -79,13 +79,7 @@ pub mod work_steal;
 /// for i in 0..2 {
 ///     local1.push_with_priority(i, i);
 /// }
-/// for i in 0..2 {
-///     assert_eq!(local1.pop(), Some(i));
-/// }
-/// for i in (2..6).rev() {
-///     assert_eq!(local1.pop(), Some(i));
-/// }
-/// for i in 6..8 {
+/// for i in 0..8 {
 ///     assert_eq!(local1.pop(), Some(i));
 /// }
 /// assert_eq!(local0.pop(), None);

core/src/common/ordered_work_steal.rs

@@ -338,10 +338,7 @@ impl<'l, T: Debug> OrderedLocalQueue<'l, T> {
     ///     local1.push_with_priority(i, i);
     /// }
     /// assert_eq!(local1.len(), 2);
-    /// for i in 0..2 {
-    ///     assert_eq!(local1.pop(), Some(i));
-    /// }
-    /// for i in (2..6).rev() {
+    /// for i in 0..6 {
     ///     assert_eq!(local1.pop(), Some(i));
     /// }
     /// assert_eq!(local0.pop(), None);
@@ -374,7 +371,7 @@ impl<'l, T: Debug> OrderedLocalQueue<'l, T> {
                         //不能偷自己
                         continue;
                     }
-                    for entry in another.iter().rev() {
+                    for entry in another {
                         let worker = entry.value();
                         if worker.is_empty() {
                             //其他队列为空